- Документирующий комментарий
-
Генератор документации — программа или пакет программ, позволяющая получать документацию, предназначенную для программистов (документация на API) и/или для конечных пользователей системы, по особым образом комментированному исходному коду и, в некоторых случаях, по исполняемым модулям (полученным на выходе компилятора).
Обычно, генератор анализирует исходный код программы, выделяя синтаксические конструкции, соответствующие значимым объектам программы (типам, классам и их членам/свойствам/методам, процедурам/функциям и т. п.). В ходе анализа также используется мета-информация об объектах программы, представленная в виде документирующих комментариев. На основе всей собранной информации формируется готовая документация, как правило, в одном из общепринятых форматов — HTMLHelp, RTF и других.
Документирующие комментарии
Документирующий комментарий — это особым образом оформленный комментарий к объекту программы, предназначенный для использования каким-либо конкретным генератором документации. От того, какой генератор документации применяется, зависит синтаксис конструкций, используемых в документирующих комментариях.
В документирующих комментариях может содержаться информация об авторе кода, описываться назначение объекта программы, смысл входных и выходных параметров — для функции/процедуры, примеры использования, возможные исключительные ситуации, особенности реализации.
Пример документирующего комментария к функции в программе на Javadoc:
/** * Проверяет, допустимый ли ход. * Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4); * @author John Doe * @param theFromFile Вертикаль, на которой находится фигура (1=a, 8=h) * @param theFromRank Горизонталь, на которой находится фигура (1...8) * @param theToFile Вертикаль клетки, на которую выполняется ход (1=a, 8=h) * @param theToRank Горизонталь клетки, на которую выполняется ход (1...8) * @return true, если ход допустим, и false, если недопустим */ boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank) { . . . }
Популярные генераторы документации
Наиболее известные генераторы документации:
Wikimedia Foundation. 2010.
