Что означает @a, @c в строках документации?
Встроенные справочные шоу Eclipse @a
а также @c
для некоторых методов вот пример:
@remarks Это создает окно как
elm_win_add()
, но также вставляет стандартный фон, используяelm_bg_add()
а также установка заголовка окна на @a title. Тип созданного окна имеет тип @c ELM_WIN_BASIC с @c NULL в качестве родительского виджета.
Что значит @a
а также @c
имею в виду?
1 ответ
Выглядит как разметка в стиле JavaDoc, которая также поддерживается Doxygen.
Все команды в документации начинаются с обратной косой черты (
\
) или знак (@
).
...
\a <word>
Отображает аргумент курсивом. Используйте эту команду, чтобы подчеркнуть слова. Используйте эту команду для ссылки на аргументы члена в текущем тексте.
\c <word>
Отображает аргумент, используя шрифт пишущей машинки. Используйте это, чтобы обратиться к слову кода. Эквивалент word tt>.