Автогенерация комментариев

[Racheengel]

Посоветуйте пожалуйста средство для автоматического документирования кода.
Т.е. надо вставить в код комменты в стиле доксигена для функций и их параметров.
Чем это можно сделать?

[kuzulis]

креатор вроде вставляет/автодополняет ...  или не то нужно?

[BRE]

Посоветуйте пожалуйста средство для автоматического документирования кода.
Т.е. надо вставить в код комменты в стиле доксигена для функций и их параметров.
Чем это можно сделать?

Нужна отдельная утилитка? Или функция среды?
Например в KDevelop есть функция "Документировать функцию".

[Racheengel]

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

[kuzulis]

Может в Doxygen есть такая фича?

[Racheengel]

Может в Doxygen есть такая фича?

да вроде как нету

[Rcus]

Doxygen умеет генерить документацию и без комментариев, только единственное что отличает такую документацию от кода это граф зависимостей, а толку от автогенератора, все равно результат будет повторять декларации.

[kuzulis]

А как насчет AutoGen ? Это что за зверь?

кстати, порылся в инете и натолкнулся на это:
http://www.yolinux.com/TUTORIALS/LinuxTutorialC++CodingStyle.html

см. там :

    *  ScanDoc: Perl script which scans C++ source code for specially-formatted comments and produces organized, indexed documentation.
      scandoc home page

    * HeaderBrowser: Create documents from file headers
      HeaderBrowser home page

может это оно?

[lit-uriy]

Racheengel, нет программы которая за тебя напишет комментарии.
Как сказал Rcus, сгенерить документацию может и Doxygen, а также и qdoc3.
Просто описания, создаваемого человеком, не будет.

[Racheengel]

очень жаль, что нет - иногда такой инструментарий очень нужен.
Все же очень утомительно вбивать шаблонные комментарии для каждой функции по 2 раза в с и h файлы...
почему бы нокии не добавить подобный функционал в креатор (или микрософту в студию)..

[lit-uriy]

>>по 2 раза в с и h файлы...
зачем по 2 раза? только один раз пишешь в *.cpp и всё

[Racheengel]

насяльника просиль...

[SASA]

В Вижал Ассисте (адон к студии) есть такая фича. Переопределяешь автотекст для документирования функции и он генерит коммент в виде дохугена. Остаётся вписать только значимую информацию.
Например, написали функцию, сгенерировали коммент и получили:

Код:

/*!	\brief
*	\param param1 (\c Type1) – 
*	\param param2 (\c Type2 *) - 
*	\see 
*	\exception 
*	\return	 (\c RetType) – 
*/
RetType Fun(Type1 param1, Type2 *param2);

 
З.Ы. В Ассисте есть неплохие возможности генерации текста.

[Racheengel]

SASA, а он может работать в полностью автоматическом режиме? чтобы можно было не на каждую функцию тыкать, а на папку с проектом...

[lit-uriy]

>>Например, написали функцию, сгенерировали коммент и получили:
получили дырку от бубулика, описание к параметрам Асисит не напишет, а коль их нет, то от заготовки толку ни какого, Доксиген это сделает и без данной заготовки

Racheengel, тебеж говорят Доксиген всё умеет, только он не умеет написать описание за человека, как и Асист. В мире не существует ни одного компьютера/программы, которая может заменить человека.