Skip to content

Commit a98e53b

Browse files
md file
1 parent a6d26f4 commit a98e53b

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This file describes a Visual Studio Code extension command for automatically generating documentation for code symbols. The extension uses AI to create explanations for variables, functions, classes, and other code elements in the current file or a specified file. Key features include:
7+
8+
1. Triggered by the `devdocs.generateDocumentation` command
9+
2. Uses configurable prompts from a `dev-docs.json` file
10+
3. Customizable options for symbol types to document and project root directories
11+
4. Aims to save time and improve code maintainability
12+
5. Requires an active AI service connection
13+
6. Can be used through the Command Palette in VS Code
14+
15+
The file explains the purpose, benefits, configuration options, prerequisites, and usage instructions for this documentation generation feature, emphasizing its utility in maintaining up-to-date documentation and onboarding new team members.
16+
17+

0 commit comments

Comments
 (0)