- Pentru indentare, folosiți 4 spații consecutive
- Folosiți spații în loc de file!
- Declarați o variabilă pe linie.
- Evitați, dacă este posibil, numele variabilelor scurte și complexe (de exemplu: "a", "rbarr", "nughdeget").
- Numele de variabile cu un singur caracter funcționează doar pentru iteratori de buclă, un context local mic și variabile temporare. În alte cazuri, numele variabilei trebuie să reflecte scopul său.
- Setați variabilele numai după cum este necesar.
- Funcțiile și variabilele ar trebui să fie numite cu o literă mare și dacă numele unei variabile sau funcții constă din mai multe cuvinte, atunci primul cuvânt trebuie să înceapă cu o literă mare, restul cu litere mici.
- Evitați abrevieri
- Numele de clase începe întotdeauna cu o literă mare.
- Utilizați linii goale pentru gruparea logică a operatorilor, acolo unde este posibil.
- Utilizați întotdeauna un șir gol ca separator
- Utilizați întotdeauna un spațiu înainte de creț
- Puneți întotdeauna un spațiu după '*' sau '' dacă acestea sunt înaintea descrierii tipului. Dar nu plasați niciodată spații după '*' sau '' și numele variabilei.
- Operațiile binare sunt separate prin spații de la 2 șiruri de caractere.
- Nu introduceți spații după conversia de tip.
- Evitați conversia tipului în stil C.
bretele
- Luați ca bază aranjamentul parantezelor deschise pe un rând cu expresia pe care o preced
- Excepție: corpul unei funcții și al unei declarații de clasă sunt deschise întotdeauna cu un braț curbat pe o linie nouă
- Utilizați paranteze curbate în condiții în care corpul condiției în mărime depășește o linie, sau condițiile corpului sunt suficient de complexe și alocarea parantezelor este cu adevărat necesară
- Excepția 1: Utilizați paranteze dacă expresia părinte constă din mai multe linii / împachetări
- Excepția 2: Folosiți bretele atunci când corpurile de ramură if-then-else ocupă mai multe linii
- Utilizați brațe pentru a desemna o stare goală a corpului
paranteze
- Utilizați paranteze pentru a grupa expresii:
Folosind constructorul comutatorului
Ștergerea liniei
- Lungimea liniei de cod nu trebuie să depășească 80 de caractere. Dacă este necesar, utilizați o pauză de linie.
- Virgulele sunt plasate la capătul liniei întrerupte; operatorii sunt plasați la începutul unei linii noi. În funcție de IDE pe care îl utilizați, operatorul de la capătul liniei întrerupte poate fi ignorat.
Moștenirea și cuvântul cheie virtual
- Când înlocuiți o metodă virtuală, nu puneți cuvântul virtual în fișierul antet.
Cum să îl folosiți
Cum se generează html
Tocmai ați creat un fișier cu documentația.
Crearea fișierului de setări
Când ați creat doar un fișier cu documentația, trebuie să creați un fișier - setările de stocare. Pentru a face acest lucru,
Editarea Doxyfile
Dacă este necesar, editați Doxyfile
- sau F4
- sau un utilitar cu o interfață grafică - pentru aceasta, pe linia de comandă
Generarea de documente
După aceea, executați crearea documentației
- fie din linia de comandă cu comanda:
- sau un utilitar cu o interfață grafică pentru un buton care arată ca o unelte - pentru asta, pe linia de comandă
Doriți să actualizați documentația pentru un fișier care deja o are, dar este depășită. La linia de comandă (în directorul în care se află Doxyfile):
Comentarii privind documentația
Documentația urmează clase, membri de clasă și funcții cu toți parametrii. În plus, pentru module individuale, în general, ar trebui să documentați cum să le utilizați.
Clasificarea documentelor
Funcții de documentare
Module de documentare
Oriunde în cod
Lucruri diferite
- Textul de pe pagina principală este @mainpage
- Creați o pagină nouă - titlul @page id
De exemplu, pagina @page pagereq Cerințe de sistem
- Creați secțiune - numele identificatorului secțiunii @
De exemplu, @ secțiunea cerințe generale comune
- Introducerea codului eșantion este @code
Această etichetă este asociată, este închisă de @endcode
- Scurta descriere - @brief
Puteți personaliza fișierul de opțiuni astfel încât prima teză din descrierea scurtă să fie transmisă punctului de descriere detaliat (descrierea implicită este considerată detaliată). Pentru a face acest lucru, activați opțiunea JAVADOC_AUTOBRIEF - în doxywizard se află pe prima pagină.
După aceasta, grupul din paranteze @<… @> De exemplu, în acest fel, puteți grupa metodele unei clase:
- Nu vă fie teamă să încălcați regulile descrise mai sus, dacă credeți că vă vor confunda codul.
Trimiteți-le prietenilor: