Генератор заголовка функции C

Question

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

Есть ли какой-нибудь инструмент для генерации заголовков функций? Я думаю, что легко добавить или удалить поле в заголовке функции, если оно поддерживается с помощью инструмента.

Пример:

/**************************************************************************** 
* NAME:        name                                     
* DESCRIPTION: text 
* ARGUMENTS:   args 
* RETURNS:     void
***************************************************************************/ 

Если завтра я планирую добавить два новых поля, «date» и «reentrant», инструмент должен быть в состоянии сделать это:

/**************************************************************************** 
* NAME:        name                                    (date) 
* DESCRIPTION: text 
* ARGUMENTS:   args 
* RETURNS:     void
* RE-ENTRANT :
***************************************************************************/ 

Самое близкое, что я мог найти, это следующее http://www.vim.org/scripts/script.php?script_id=938. Однако это зависит от редактора VI, и я не лучший поклонник VI.

Какой-то простой скрипт тоже должен подойти.

Answer 1

Я бы предложил разделить то, что вы пытаетесь сделать, на две отдельные части.

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

С другой стороны, полезно извлекать функции и их переменные в документацию. Как упомянуто в комментарии bcr, doxygen хорошо справляется с этой задачей. Это инструмент, похожий на javadoc, но ориентированный на C / C ++, и я довольно широко его использовал.

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

Подробнее здесь: http://www.doxygen.nl/

Answer 2

Какой ты иде?

• В некоторых инструментах, таких как Visual Studio, Eclipse или других больших интегрированных средах разработки, в которые он встроен, или в плагинах (Eclipse).

• В некоторых редакторах, таких как emacs, во время написания кода я написал небольшой скрипт, который выполнял эту работу. Вы можете легко справиться с некоторыми вызовами cat, grep и sed. Или сделайте какой-нибудь код, чтобы сделать работу.