codenarrator

CodeNarrator is a sophisticated Visual Studio Code extension that harnesses the power of artificial intelligence (AI) to streamline code documentation. With CodeNarrator, documenting your code has never been easier. It employs AI to analyze your code and generate comprehensive documentation for functions, classes, methods, variables, and more.

Features

Automatic Documentation Generation Seamlessly generates code documentation for your codebase. Supports multiple programming languages, including Python, JavaScript, Java, C++, and more. Automatically detects and documents functions, classes, methods, variables, and parameters.

Requirements

Extension Settings

Include if your extension adds any VS Code settings through the contributes.configuration extension point.

For example:

This extension contributes the following settings:

• myExtension.enable: Enable/disable this extension.
• myExtension.thing: Set to blah to do something.

Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.

Release Notes

Users appreciate release notes as you update your extension.

1.0.0

Initial release of ...

1.0.1

Fixed issue #.

1.1.0

Added features X, Y, and Z.

---

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux)
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!