DocMan

DocMan — VS Code extension to generate and manage project documentation from source comments and code.

Overview

DocMan helps maintain project documentation by parsing in-source comments and generating documentation files and previews. It's implemented as a small VS Code extension with modular components for comment parsing and documentation generation.

Features

• Generate documentation from annotated source files
• Parse and extract structured comments
• Provide commands to preview and export docs
• Includes unit tests and an extension test harness

Quick Start

1. Clone the repository and open it in VS Code.
2. Install dependencies:

npm install

3. Run tests:

npm test

4. Run the extension in the VS Code Extension Development Host (F5).

Project Structure

• src/extension.js — Extension entry point and activation
• src/documentation.js — Documentation generation logic
• src/comments.js — Comment parsing utilities
• src/unitTests.js — lightweight unit helpers
• test/extension.test.js — integration / extension tests

Architecture

graph LR
  User["User / VS Code UI"] -->|Triggers Command| Extension["Extension (src/extension.js)"]
  Extension --> Commands{"Commands"}
  Commands --> DocGen["src/documentation.js"]
  Commands --> CommentParser["src/comments.js"]
  DocGen --> FS["File System (README.md, docs/)"]
  CommentParser --> DocGen
  Extension --> Tests["test/ and src/unitTests.js"]

Loading

This shows how user actions in VS Code flow through the extension entrypoint to the specific modules that parse code and emit documentation files.

User Flow

flowchart TD
  A[Install Extension] --> B[Open Workspace]
  B --> C[Run Generate Docs Command]
  C --> D[Extension activates - src/extension.js]
  D --> E[Parse source files - src/comments.js]
  E --> F[Generate docs - src/documentation.js]
  F --> G[Write files and open preview]
  G --> H[User reviews and commits docs]

Loading

Suggested GitHub Description

DocMan — A VS Code extension that generates and manages project documentation by parsing in-source comments and producing README and docs artifacts.

Suggested GitHub Topics / Tags

• vscode-extension
• documentation
• doc-generator
• javascript
• nodejs
• tooling

Development Notes

• To extend parsing rules, edit src/comments.js.
• To change generation templates, edit src/documentation.js.
• Tests live in test/ and can be run via npm test.