Come scrivere commenti sulla documentazione in ANSI C?[Chiuso]

Question

Non riesco a trovare come scrivere commenti in C. Voglio dire, conosco // e /* */, quello che voglio dire è dove posso trovare buone pratiche?Come se avessi una funzione, come scrivo il @param variable is the value bla bla, come si fa in Java?

Esistono degli standard per questo?O posso semplicemente farlo come lo faccio in Java?

Answer 1

Esistono molti standard diversi, se desideri generare documentazione, prova doxygen

Answer 2

Non esistono standard che seguono gli standard imposti dalla tua azienda.
Un modo diffuso per creare documentazione dai progetti è utilizzare doxygen .

Answer 3

Puoi utilizzare lo standard javadoc e quindi utilizzare doxygen che comprende javadoc per generare una documentazione.

In doxygen consiglio di utilizzare l'opzione JAVADOC_AUTOBRIEF impostata su YES.Se il tag JAVADOC_AUTOBRIEF è impostato su YES, doxygen interpreterà la prima riga (fino al primo punto) di un commento in stile Javadoc come breve descrizione.

Esempio per una definizione di classe:

/**
 * A brief description. A more elaborate class description
 * @param bool somebool a boolean argument.
 * @see Test()
 * @return The test results
 */

(Alcuni altri esempi nel manuale doxygen )

L'installazione è davvero semplice, c'è una GUI e una bella visualizzazione grafica disponibile con:

apt-get install doxygen doxygen-gui graphviz

Esegui la gui chiamando doxywizard e utilizza le impostazioni della procedura guidata, nelle impostazioni "Esperto" deve essere impostato solo JAVADOC_AUTOBRIEF.

Answer 4

Un'opzione è usare il formato doxygen per scrivere commenti: questo ha l'ulteriore vantaggio di poter generare html / latex e altri tipi di documenti per il tuo codice.