Я не могу найти, как писать комментарии на C. Я имею в виду, что я знаю о // и /* */, что я имею в виду, где я могу найти хорошие практики? Как если бы у меня была функция, как мне написать @param variable is the value bla bla, как это делается на Java?Как написать комментарии к документации в ANSI C?
Существуют ли какие-либо стандарты для этого? Или я могу просто сделать это, как я делаю это на Java?
Есть много различных стандартов, если вы хотите создать документацию, попробуйте doxygen
Там нет стандартов следует стандарта, который ваша компания мандаты.
Популярным способом создания документации из проектов является использование Doxygen.
Опция заключается в использовании формата doxygen для написания комментариев - это имеет дополнительное преимущество, заключающееся в возможности генерации html/latex и других видов документов для вашего кода.
Вы можете использовать стандарт javadoc, а затем использовать doxygen, который понимает javadoc для создания документации.
В doxygen Я рекомендую использовать опцию JAVADOC_AUTOBRIEF, установленную на YES. Если для тега JAVADOC_AUTOBRIEF установлено значение YES, то doxygen интерпретирует первую строку (до первой точки) комментария стиля в стиле Javadoc как краткое описание.
Пример для определения класса:
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
(еще несколько примеров in the doxygen manual)
Установка очень прост, есть графический интерфейс и приятные графические визуализации доступны с:
apt-get install doxygen doxygen-gui graphviz
Запустите gui, вызывающий doxywizard, и используйте настройки мастера, только JAVADOC_AUTOBRIEF должен быть установлен там в настройке «Эксперт» ь.
Хороший ответ с примером. – Drew
На самом деле вы даже не можете использовать '//' в ANSI C. Только с C99 они разрешили '//'. (Хотя GCC допускает его как расширение.) – Mysticial
Только поддержка '/ * * /' поддерживается в C. '//' является добавлением в C++ –
Термин ANSI C обычно относится к языку, описанному в стандарте ANSI 1989 года , но, строго говоря, это неверно. В 1990 году ИСО выпустил тот же стандарт (с некоторыми новыми вводными материалами и перенумерованными разделами), и ANSI принял его. В 1999 году ISO выпустила новый стандарт C, и ANSI также приняла его, сделав стандарт 1989/1990 официально устаревшим. В конце 2011 года ИСО выпустила еще один новый стандарт С, который ANSI также принял. За исключением первых, стандарты C первоначально публикуются ISO, а не ANSI, и лучше всего ссылаться на стандарты по годам. –