Какое-либо программное обеспечение к автоматическому генерирует doxygen блоки комментария?
Поскольку нет способа добавить атрибут enable-false норм как часть аннотаций @field в сущности java, мы можем добавить все сопоставления (все необходимые типы с атрибутами в качестве сопоставлений) в файл mappings.json и ссылаться на этот файл в сущности. файл. Как показано ниже
@Document(indexName = "jobindex")
@Setting(settingPath = "/config/elasticsearch-settings.json")
@Mapping(mappingPath = "/config/mappings.json") //THIS ONE TO ADD
public class JobIndex implements Serializable {
}
и mappings.json выглядят как
"mappings": {
"_doc": {
"properties": {
"title": {
"type": "text",
"norms": { "enabled": false }
}
}
}
}
ПРИМЕЧАНИЕ: когда вы добавляете в атрибут mappings.json определенные атрибуты, которые недоступны в аннотациях java @Field, лучше добавлять все полевые аннотации в файл json, а не в java @ полевые аннотации. Таким образом, вывод заключается в том, что сущность java должна быть без аннотаций полей, и все сопоставления должны быть в файле mappings.json, и этот файл должен быть указан в заголовке сущности, как упомянуто в первом блоке кода этого ответа.
3 ответа
Вы также можете настроить Doxygen на извлечение недокументированных элементов - это может делать то, что вы хотите, без добавления ЛЮБЫХ блоков комментариев в код.
После этого вы можете создавать шаблоны / макросы (в зависимости от вашей IDE) для создания предварительно отформатированных блоков для каждого типа элементов, медленно работая с кодом, документируя элементы один за другим.
[edit] Если вы используете Visual Studio, для классов и других конструкций в файле доступен некоторый самоанализ, который может помочь. Или посмотрите Doxycomment - это может быть то, что вам нужно.
Проверьте своего редактора. Я использовал редактора CodeWright, и это имеет функцию, названную выборочным дисплеем. Настроенный правильно я могу нажать значок, и только первая строка функциональных определений отображена. С другой стороны, можно использовать блок, выходят из строя/расширяют в некоторых других редакторах. Так или иначе помогает быстро перейти через Ваш исходный код к заголовкам/определениям, и т.д. и затем вставить некоторый шаблонный комментарий, чтобы быть заполненным в позже. Я часто использую свои собственные поисковые теги, например, COMMENTME в моем коде, к которому я могу возвратиться с простыми поисками.
Я очень недоумеваю.
Какова цель автоматической генерации комментариев?
Комментарии призваны принести дополнительную пользу:
/**
* \brief: finds the person based on its name
* \param: name, the name of the person
* \result: the person
*/
Person findPerson(Name name);
Не что иное, как беспорядок в коде, засоряет мое ценное пространство на экране. И это примерно столько, сколько может быть сгенерировано автоматически, к сожалению ... Заметьте, в частности, что я понятия не имею, что произойдет, если функция когда-либо не найдет человека, что, безусловно, кажется вероятным: прерывается ли она? кидает? (что ...?) возвращает созданный по умолчанию объект?
С другой стороны:
///
/// Try an exact match approach to begin with
/// Uses the double metaphone algorithm
/// if none was found as we have
/// a western european clientele
///
Person findPerson(Name name)
{
}
гораздо интереснее!
- Теперь я знаю, что это за странная коллекция
, если, кажется, выполняет какое-то распознавание звука ... - Я знаю ее название, поэтому могу найти ее в Интернете, чтобы проверить ее реализация (функциональность)
- И я знаю, почему он был выбран, и, следовательно, когда мне следует переоценить его использование (подходит для западноевропейской клиентуры, поэтому, если мы будем развиваться на арабском рынке, потребуется адаптация ...)
К сожалению, это не будет генерироваться автоматически.