Изменить стиль комментариев Doxygen в Eclipse

Question

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

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

/**
 * 
 * @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).

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

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

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

Answer 1

Да, это похоже на ошибку в Eclipse CDT.

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

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

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

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

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

com<Ctrl+space>

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

Примечание:

com<Ctrl+space+space>

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

Answer 2

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

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

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

Answer 3

Тег 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 и затмении. Поскольку Doxygen действителен для нескольких языков, он действителен и для C / C ++.

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

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

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

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

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

Answer 4

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

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