Non riesco a trovare come scrivere commenti in C. Voglio dire che so di // e /* */, che cosa intendo è dove posso trovare buone pratiche? Come se avessi una funzione, come scrivo lo @param variable is the value bla bla, come se fosse fatto in Java?Come scrivere i commenti della documentazione in ANSI C?
Esistono standard per questo? O posso farlo come faccio in Java?
Ci sono molti standard diversi, se si desidera generare la documentazione, provare doxygen
Non ci sono standard seguono lo standard cui i vostri mandati aziendali.
Un modo popolare per creare documentazione dai progetti è utilizzare Doxygen.
Un'opzione consiste nell'utilizzare il formato doxygen dei commenti di scrittura - questo ha l'ulteriore vantaggio di essere in grado di generare html/latex e altri tipi di documenti per il codice.
È possibile utilizzare lo standard javadoc e quindi utilizzare doxygen che comprende javadoc per generare una documentazione.
In doxygen, si consiglia 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 descrizione breve.
Esempio di 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 in the doxygen manual)
L'installazione è molto semplice, v'è un'interfaccia grafica e una visualizzazione grafica bella disponibili con:
apt-get install doxygen doxygen-gui graphviz
Esegui la chiamata gui doxywizard e usa le impostazioni della procedura guidata, solo JAVADOC_AUTOBRIEF deve essere impostato lì in "Esperto" sett Ings.
Una bella risposta con un esempio. – Drew
In realtà, non si può nemmeno usare '//' in ANSI C. Solo da C99 hanno permesso '//'. (Sebbene GCC lo consenta come estensione.) – Mysticial
Solo '/ * * /' è supportato in C. '//' è un'aggiunta in C++ –
Il termine "ANSI C" si riferisce in genere al linguaggio descritto dallo standard ANSI 1989 , ma a rigor di termini non è corretto. Nel 1990, l'ISO emanò lo stesso standard (con qualche nuovo materiale introduttivo e sezioni rinumerate) e l'ANSI lo adottò. Nel 1999, l'ISO ha emesso un nuovo standard C e ANSI lo ha adottato, rendendo ufficialmente obsoleto lo standard 1989/1990. Alla fine del 2011, ISO ha emesso un altro nuovo standard C, che ANSI ha anche adottato. Tranne che per il primo, gli standard C sono inizialmente pubblicati da ISO, non ANSI - ed è meglio fare riferimento agli standard per anno. –