Comanda /doc (Generare de Documentație) în GitHub Copilot

Comenzi Slash Copilot Nivel: începător

Adaugă comentarii curate și standardizate deasupra funcțiilor, descriind parametrii, tipurile și excepțiile returnate.

Sintaxă & invocare
/doc – generarea comentariilor standardizate de documentație (JSDoc, Docstrings, PHPDoc)

Descriere & Utilizare

Păstrarea documentației de cod la zi este esențială pentru munca în echipă. Cu /doc, Copilot scrie blocuri standardizate de documentație conform convenției limbajului utilizat.

Recunoaște automat tipurile din semnătura funcției și deduce rolul fiecărui parametru din corpul implementării.

Cum să o reții ușor

💡 Prospectul oficial al unui medicament: explică clar compoziția, modul de administrare, contraindicațiile și efectele adverse.

Opțiuni și flux operațional

  • Inserează blocul de comentarii direct deasupra liniei de definiție a funcției.

Exemple practice și prompturi utile

  • Selectezi o funcție TypeScript -> /doc generează comentarii JSDoc complete cu exemple de apel
  • În Python: /doc formatează conform stilului Google Python Docstring

Bune practici și capcane de evitat

Comanda /doc este extrem de utilă pentru librăriile exportate public, facilitând auto-completarea în IDE-ul altor dezvoltatori.

Comenzi și scurtături înrudite