Ce face /doc
Tabelul de comenzi din VS Code descrie /doc ca generarea de comentarii de documentație din inline chat-ul editorului. Deschizi inline chat cu Ctrl+I (Windows, Linux) sau ⌘+I (macOS) și scrii /doc.
Fișa GitHub listează /doc și pentru Visual Studio („adaugă un comentariu de documentație pentru acest simbol”) și Xcode. Poți adăuga după comandă stilul dorit, de exemplu JSDoc sau docstrings.
Sintaxă și opțiuni
| Opțiune / Parametru | Descriere |
|---|---|
[stil] |
Opțional: convenția de documentație dorită. |
Exemple practice
Exemplul 1: Docstring în stil Google
/doc folosește stilul Google pentru docstrings Python
Greșeli frecvente și bune practici
- Scrii
/docîn panoul de chat și aștepți comentariile în fișier. Comanda este documentată pentru inline chat. - Lași în comentarii descrieri care nu corespund codului. Citește-le înainte de commit.