Могу ли я использовать GhostDoc для добавления документации ко всему файлу класса или кода?
Мне нравится GhostDoc, но я хочу иметь возможность "Документировать это" для всего файла, а не только для одного участника за раз. Это возможно?
3 ответа
Когда я первоначально ответил на этот вопрос, это было невозможно в GhostDoc или в моем (аналогичном) дополнении, Документация Atomineer Pro).
(Это был преднамеренный выбор дизайна в Atomineer, и, вероятно, также в GhostDoc, потому что вообще плохая идея документировать все автоматически и двигаться дальше. Оба этих дополнения создают разумную отправную точку для документирования метода, а иногда они обеспечивают хорошее Достаточно документации, чтобы вам не нужно было вносить какие-либо корректировки, но в большинстве случаев вы захотите настроить полученный комментарий. Если вы автоматически сгенерируете весь набор документации, то документы будут довольно скудными, потому что они мало что сделают больше, чем описание того, что уже указано в именах элементов кода).
Однако теперь оба дополнения предоставляют эту функцию, которая очень полезна в следующих ситуациях:
- (в Atomineer) Пакетное преобразование устаревших комментариев между форматами документации JavaDoc, Doxygen, Qt и XML
- (в Atomineer) Обновление стиля / макета комментариев документации после изменения параметров форматирования AtomineerUtils
- (в обоих дополнениях) Для быстрого добавления документации скелета в класс
Во всех этих ситуациях настоятельно рекомендуется просмотреть полученные комментарии, но автоматизация обновления экономит много времени.
Использовать параметр файла документа:
Выберите опцию файла документа
увидеть комментарий, добавленный для всех участников в файле