Могу ли я использовать GhostDoc для добавления документации ко всему файлу класса или кода? - PullRequest
2 голосов
/ 01 октября 2009

Мне нравится GhostDoc, но я хочу иметь возможность "Документировать это" для всего файла, а не только для одного участника за раз. Возможно ли это?

Ответы [ 3 ]

2 голосов
/ 04 октября 2009

Когда я первоначально ответил на этот вопрос, это было невозможно в GhostDoc или в моем (похожем) дополнении, Документация Atomineer Pro ).

(Это был преднамеренный выбор дизайна в Atomineer, и, вероятно, также в GhostDoc, потому что, как правило, плохая идея документировать все автоматически и двигаться дальше. Оба этих дополнения создают разумную отправную точку для документации метода, и иногда они будут предоставлять достаточно хорошую документацию, чтобы вам не нужно было вносить какие-либо корректировки - но в большинстве случаев вам захочется настроить полученный комментарий. Если вы автоматически сгенерируете весь набор документации, то документы будут довольно скудными потому что они сделают немного больше, чем просто описывают то, что уже указано в именах элементов кода).

Однако , теперь оба дополнения предоставляют эту функцию, которая очень полезна в следующих ситуациях:

  • (в Atomineer) Пакетное преобразование устаревших комментариев между форматами документации JavaDoc, Doxygen, Qt и XML
  • (в Atomineer) Обновление стиля / макета комментариев документации после изменения параметров форматирования AtomineerUtils
  • (в обоих дополнениях) Для быстрого добавления документации скелета в класс

Во всех этих ситуациях настоятельно рекомендуется просматривать полученные комментарии, но автоматизация обновления экономит много времени.

1 голос
/ 01 октября 2009

Нет. Я все еще люблю это также независимо.

0 голосов
/ 23 января 2018
...