VS Code Documentation and Comment Review Workflow Using Extensions
Plan a lightweight workflow for documenting code.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
[VERIFY] is an editorial flag, not a blank to fill. Wherever the prompt shows [VERIFY], check that item against a reliable source before you use it.
Plan how my team documents code using VS Code. Languages: [LANGUAGES]. Current documentation habits: [HABITS]. Documentation formats we publish: [FORMATS]. Write a short style guide of six rules, each with a before and after example using invented code in my language. Explain the difference between documentation for users of a function and comments for maintainers: explain why, constraints and trade-offs; do not comment the obvious. Keep comments honest: delete commented-out code, update comments in the same commit as the change, and link to decisions instead of retelling them. Examples for a function and a module. Extensions or built-in features that help (spell checking, Markdown preview, docstring generators) [VERIFY]; check publishers before installing. Review checklist of five questions, such as whether the comment says why and not only what. Check documentation in the build: lint docstrings and fail on broken links where tools allow [VERIFY]. Keep the guide short enough to read before a review, and say which rule catches the most real problems. Suggest one small habit for the team to try for a month and a way to see whether it helped.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.