# 10. Документирование классов с помощью KDoc

Другая важная часть документации - краткое описание интерфейса классов. Это позволит вам и другим программистам использовать ваши классы, читая HTML файлы документации классов, которая создается с помощью `KDoc` . KDevelop поддерживает использование `KDoc` для создания документации к KDE-библиотекам, и ваш шаблон уже документирован. Для работы с предлагаемым в нем кодом полезно прочитать online-документацию. Данная глава описывает, что необходимо сделать для документирования API , и как KDevelop поможет вам в этом, также рассматриваются дополнительные таги, поддерживаемые `KDoc` .

# 10.1. Как использовать возможности KDevelop по документированию

Для создания документации API после разработки проекта выберите "Make API -Doc" из меню "Project". Это приведет к просмотру всех файлов заголовков и созданию на их основе HTML файлов документации. После этого вы сможете получить доступ к документации, выбирая "API -Documentation" из меню помощи или соответствующую книгу в дереве документации, папка "Current Project".

Документация уже содержит ссылки на KDE и Qt online-документацию классов, поэтому вы сможете проследить наследование и легко обозреть иерархию. Это может вам также помочь в начале работы с документацией KDE и Qt .