What it does: Hover over files or folders in the Explorer, and CommentTree shows your custom comments as tooltips. It reads comments from README.md or a comments.tree file in your project.
Example
Suppose your project folder looks like this:
MyProject/
├─ src/
│ ├─ index.ts
│ └─ utils.ts
├─ README.md
└─ package.json
There are two formats available
If your tree is in README.md, include ## Project Structure You can change '## Project Structure' to any other text in settings.
First format:
## Project Structure
MyProject
src # Contains all source codesdasd
index.ts # Main entry point
utils.ts # Utility functions
package.json # Project configuration
Second Format
## Project Structure
MyProject
├src # Contains all source code
│ ├index.ts # Main entry point
│ └utils.ts # Utility functions
└package.json # Project configuration
What you’ll see in VS Code:
Hover over src/ → Tooltip: "Contains all source code"
Hover over index.ts → Tooltip: "Main entry point"
Hover over utils.ts → Tooltip: "Utility functions"
Hover over package.json → Tooltip: "Project configuration"