Nie mogę znaleźć komentarzy w C. Chodzi mi o to, że wiem o // i /* */, mam na myśli to, gdzie mogę znaleźć dobre praktyki? Podobnie jak w przypadku funkcji, jak mogę napisać @param variable is the value bla bla, tak jak to jest zrobione w Javie?Jak pisać komentarze do dokumentacji w ANSI C?
Czy istnieją jakieś standardy w tym zakresie? Czy mogę po prostu zrobić to tak, jak robię to w Javie?
Istnieje wiele różnych standardów, jeśli chcesz generować dokumentację, spróbuj doxygen
Nie ma standardów, które są zgodne ze standardem twoje mandaty firmowe.
Popularnym sposobem tworzenia dokumentacji z projektów jest użycie Doxygen.
Opcja polega na użyciu formatu doxygen do pisania komentarzy - ma to tę dodatkową zaletę, że umożliwia generowanie html/latex i innych rodzajów dokumentów dla twojego kodu.
Można użyć standardu javadoc, a następnie użyć doxygen, który rozumie język javadoc w celu wygenerowania dokumentacji.
W doxygen zalecam użycie opcji JAVADOC_AUTOBRIEF ustawionej na YES. Jeśli znacznik JAVADOC_AUTOBRIEF jest ustawiony na TAK, to doxygen będzie interpretował pierwszy wiersz (do pierwszej kropki) komentarza w stylu Javadoc jako krótki opis.
Przykład definicji klasy:
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
(Więcej przykładów in the doxygen manual)
montaż jest bardzo prosty, jest GUI i ładny wizualizacji graficzny dostępny z:
apt-get install doxygen doxygen-gui graphviz
Uruchom wywołanie GUI doxywizard i użyj ustawień Kreatora, tylko JAVADOC_AUTOBRIEF musi być tam ustawiony w ustawieniu "Ekspert" rządy.
Ładna odpowiedź z przykładem. – Drew
W rzeczywistości nie można nawet używać '//' w ANSI C. Tylko z C99 zezwolono na '//'. (Chociaż GCC zezwala na to jako rozszerzenie.) – Mysticial
Tylko '/ * * /' jest obsługiwane w C. '//' jest dodatkiem w C++ –
Termin "ANSI C" zwykle odnosi się do języka opisanego w standardzie ANSI 1989 , ale mówiąc ściśle, jest to niepoprawne. W 1990 r. ISO wydało ten sam standard (z kilkoma nowymi materiałami wprowadzającymi i numeracją sekcje), a ANSI go przyjęła. W 1999 r. ISO wydało nowy standard C, a ANSI również go przyjęła, czyniąc standard 1989/1990 oficjalnie przestarzałym. Pod koniec 2011 r. ISO wydała kolejny nowy standard C, który ANSI również przyjęła. Z wyjątkiem pierwszego, normy C są początkowo publikowane przez ISO, a nie ANSI - i najlepiej jest odwoływać się do norm po roku. –