Печать страницы - Автогенерация комментариев

Название: Автогенерация комментариев
Отправлено: Racheengel от Ноябрь 04, 2009, 13:43

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

Название: Re: Автогенерация комментариев
Отправлено: kuzulis от Ноябрь 04, 2009, 13:45

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

Название: Re: Автогенерация комментариев
Отправлено: BRE от Ноябрь 04, 2009, 13:47

Цитата: Racheengel от Ноябрь 04, 2009, 13:43

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

Название: Re: Автогенерация комментариев
Отправлено: Racheengel от Ноябрь 04, 2009, 13:47

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

Название: Re: Автогенерация комментариев
Отправлено: kuzulis от Ноябрь 04, 2009, 13:52

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

Название: Re: Автогенерация комментариев
Отправлено: Racheengel от Ноябрь 04, 2009, 13:54

Цитата: kuzulis от Ноябрь 04, 2009, 13:52

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

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

Название: Re: Автогенерация комментариев
Отправлено: Rcus от Ноябрь 04, 2009, 13:55

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

Название: Re: Автогенерация комментариев
Отправлено: kuzulis от Ноябрь 04, 2009, 14:01

А как насчет 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

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

Название: Re: Автогенерация комментариев
Отправлено: lit-uriy от Ноябрь 04, 2009, 14:47

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

Название: Re: Автогенерация комментариев
Отправлено: Racheengel от Ноябрь 04, 2009, 17:44

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

Название: Re: Автогенерация комментариев
Отправлено: lit-uriy от Ноябрь 04, 2009, 18:18

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

Название: Re: Автогенерация комментариев
Отправлено: Racheengel от Ноябрь 04, 2009, 18:46

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

Название: Re: Автогенерация комментариев
Отправлено: SASA от Ноябрь 04, 2009, 19:35

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

Код:

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

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

Название: Re: Автогенерация комментариев
Отправлено: Racheengel от Ноябрь 05, 2009, 10:48

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

Название: Re: Автогенерация комментариев
Отправлено: lit-uriy от Ноябрь 05, 2009, 17:12

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

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

Название: Re: Автогенерация комментариев
Отправлено: SASA от Ноябрь 06, 2009, 10:23

Цитировать

получили дырку от бубулика, описание к параметрам Асисит не напишет

Конечно не пишет. Но весь текст, который можно сгенерить автоматически - генерит.

Цитировать

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

Пока ;D ;D ;D

Цитата: Racheengel от Ноябрь 05, 2009, 10:48

Наверное нет.

Название: Re: Автогенерация комментариев
Отправлено: lit-uriy от Ноябрь 06, 2009, 18:39

>>Но весь текст, который можно сгенерить автоматически - генерит.
Для вопрошающего в этом нет нужды, т.к. сами коментарии он писать не хочет

Russian Qt Forum

Программирование => Общий => Тема начата: Racheengel от Ноябрь 04, 2009, 13:43