Изменение стиля комментариев doxygen в Eclipse

Кто-нибудь знает, как отредактировать стиль, используемый для комментариев Doxygen в Eclipse CDT?

Другими словами, тип /** и нажатие enter на строке перед функцией в настоящее время дает мне что-то вроде:

/**
 * 
 * @param one
 * @param two
 * @return
 */
Foo(int one, int two);

и я хочу, чтобы он дал мне что-то вроде:

/**********************************************************************/
///
/// \param one
/// \param two
/// \return
/***********************************************************************/
Foo(int one, int two);

Кроме того, плюс один, если кто-нибудь знает, как связать это с ярлыком на клавиатуре (например, alt - shift - j для Eclipse JDT).

Кроме того, FYI, тот факт, что Eclipse CDT поддерживает Doxygen, теперь, по-видимому, малоизвестный факт, основанный на Google. Подробнее см. здесь. Doxygen можно включить в свойствах проекта, выбрав "Включить специальные настройки проекта" на вкладке "C/С++ General" и выбрав "Doxygen". Моя версия CDT - 7.0.1, но я думаю, что это стало доступно в версии 5.0.

Наконец, раздел комментариев в шаблонах кода в настройках не выполняет этого на основе моего тестирования.

EDIT: См. здесь. Кажется, что стиль комментария жестко закодирован. Если кто-то найдет иное, я бы хотел узнать об этом. Я думаю, что шаблоны будут лучше всего на данный момент, если стиль Javadoc не подходит для вас.

Ответ 1

Да, это кажется ошибкой в Eclipse CDT.

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

В Eclipse Helios: Окно → Настройки → C/С++ → Редактор → Шаблоны

Нажмите "Создать...", чтобы создать новый шаблон, и в поле "Имя" используйте некоторое описательное имя, например. "comment-function" и добавьте комментарий doxygen в поле "Pattern". Подтвердите и примените это изменение.

В своем коде вы можете перейти к строке над объявлением функции, введите первые несколько букв вашего имени настраиваемого шаблона, а затем комбинацию клавиш Ctrl + Space.

В этом примере:

com<Ctrl+space>

отобразит диалоговое окно Content Assist, отфильтрованное с помощью "com *", из которого вы можете выбрать шаблон "comment-function".

Примечание:

com<Ctrl+space+space>

будет фильтроваться еще дальше, только показывая предложения шаблонов во всплывающем окне Content Assist.

Ответ 2

Это конфигурация, которую я нашел в своем комментарии java

и когда я отредактировал, как показано, мой комментарий к java doc изменился на

Попробуйте найти аналогичную конфигурацию в вашей конфигурации php.

Ответ 3

Я могу найти путь к тому, что вы хотите, перейдя к: Предпочтения - PHP - стиль кода - шаблоны кода - комментарии.

Я не уверен, что это позволит вам использовать обратную косую черту вместо @s для ваших ключевых слов, но я думаю, что она должна достичь большей части того, что вы хотите.

Ответ 4

Тег Doxygen использует этот базовый формат.

/**
Your tags and such. It MUST have the /** and the */.
*/

Абсолютно необходимо иметь /** */вокруг всего комментария Doxygen. Если вы измените Шаблоны кода, он будет делать то, что вы хотите.

Предлагаемый стиль комментариев неправильный, хотя.

/***************/ <-- These are terminated Doxygen blocks.
/// <-- These are used in xml style Doxygen blocks.
///
/// This isn't actually a Doxygen block and shouldn't work
/// if you run Doxygen on it.
///
/***************/ <-- These are terminated Doxygen blocks.

Это ниже стандартно для большинства компаний, которые кодируют JAVA и eclipse. Поскольку Doxygen действителен для нескольких языков, это справедливо и для C/С++.

/**
 * Brief description.
 *
 * @param[in|out] <value> <description>
 */

Если вы хотите использовать теги стиля xml...

/// <summary>
/// This is a summary of the class, blah, blah.
/// </summary>

Вы также захотите убедиться, что eclipse также не вставляет другие стили комментариев, иначе вы можете добавить комментарии, добавленные внутри других комментариев. Также, как правило, это плохое правило для смешивания стилей комментариев, таких как /** */и///.

Наконец, если вы выберете автогенерирование комментариев при создании классов, и такие комментарии будут автоматически добавлены. И вы можете иметь заголовок метода автоматического генерации eclipse при вводе (хотя я забыл, как я это сделал).