Рабочая среда К

10.2. Добавление документации классов и их членов

KDevelop предоставляет как способы автоматического добавления кода, так и способы автоматического документирования. Когда вы используете генератор классов, выбирая "Project"->"New Class", добавьте краткое описание класса в поле документирования. Это вставит его в заголовок класса.

При добавлении в класс функции-члена и атрибутов с помощью classtools , добавьте краткое описание члена в поле документирования.

Вы можете подумать, что документация - это часть процесса разработки, которая не очень важна. Но помните, что большинство проектов растут, и все больше и больше людей начинают принимать участие в их разработке. Поэтому документирование классов - хороший путь сэкономить время. Даже если вы присвоили методам имена, точно описывающие их назначение, очень вероятно, что их не поймут или со временем изменятся функции метода. Поэтому поддерживайте в порядке вашу документацию и обновляйте ее как можно чаще.

Несмотря на вышесказанное, файлы документации НЕ включаются в проект, и не интернационализируются. Поэтому вся документация API должна быть написана на английском, чтобы позволить работать с ней международной команде.

Если вы хотите добавить документирование вручную в файл заголовка, добавьте его над методом или классом в виде C-комментария с одним отличием - первая строка должна начинаться со слеша и двух звездочек.

Например:

   /** enables menuentries/toolbar items
   	*/
   void enableCommand(int id_);