Розділ документації: Розділ документації складається з набір рядків коментарів із назвою програми, автором та іншими деталями, які компілятор ігнорує.20 травня 2024 р
Документація функції має містити такі поля:
- Короткий однорядковий опис функції та її призначення, указане за допомогою @brief.
- Детальний опис функції.
- Параметри (зазначені за допомогою @param)
- Повернене значення (зазначене за допомогою @return)
- @see для посилання на пов’язані функції.
«Офіційною» документацією для мови програмування C є Стандарт ISO. Ви можете придбати його там або в іншої організації стандартизації (що може бути дешевше!). Або ви можете натомість ознайомитися з однією з вільно доступних "чорнових" специфікацій. Останнім з них є N3054.
У програмі C є 6 розділів Документація, розділ препроцесора, визначення, глобальна декларація, функція Main() і підпрограми.
Розділ посилань. Він складається з директив препроцесора, які пов'язують компілятор із функціями стандартної бібліотеки. Ми включаємо різні попередньо визначені стандартні бібліотечні функції в наші програми на C, і всі ці різні бібліотечні функції доступні в різних стандартних файлах заголовків.
Розділ документації: Розділ документації складається з набір рядків коментарів із назвою програми, автором та іншими деталями, які компілятор ігнорує.