Редактор документации кода

Question

Я искал приложение для редактирования документации кода.Я имею в виду не просто инструмент генерации, такой как doxygen, но приложение, которое позволяет мне редактировать документацию и изменять ее непосредственно в коде.

Кто-нибудь знает о хорошем редакторе?

Спасибо!

Answer 1

Если вы говорите о Visual Studio ...

Я написал надстройку, Документация AtomineerUtils Pro , которая очень поможет при создании и редактировании документации.

• Чтобы создавать комментарии, надстройка использует как можно больше информации из элемента кода, который вы документируете, чтобы добавить его в комментарии к документации скелета. Он изо всех сил старается предоставить полезную информацию в удобочитаемой английской форме (поэтому пытается генерировать значимые документы и документирует множество вещей, которые не сразу "очевидны" из самого кода, например, исключения, которые выдает метод)

• Для обновления комментариев он может синхронизировать комментарий с кодом - поэтому, если вы добавляете / удаляете / переименовываете параметры, изменяете создаваемые исключения и т. Д., Он обновляет комментарий, чтобы точно отражать новое состояние кода, который вы Документируем.

• Он применяет настраиваемую перенос слов, управление пробелами и форматирование блоков, чтобы обеспечить аккуратность, правильность и согласованность блоков комментариев.

• Поддерживает множество языков (C ++, C, C ++ / CLI, C #, Java, VB), документацию Xml, форматы документов Doxygen, Qt и JavaDoc,

Если вам нужна система документации, которая обеспечивает WYSIWYG-редактирование документации, не приближаясь к исходному коду, то я считаю, что что-то более похожее на Document! X может удовлетворить ваши потребности лучше (я думаю, вам придется написать всю документацию самостоятельно, но она больше направлена ​​на создание внешней документации, чем на предоставление документации в коде)

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

Answer 2

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

Проблема в том, что код (и комментарии) находятся в управлении версиями и что необходимо отслеживать . Вы не можете обойти это.

Что бы это ни стоило, вы видите логическую разницу между редактированием кода и комментариев, но вы редактируете те же файлы. Программисты не видят разницы между этими вещами и будут по-настоящему смущены вашей терминологией. Я подозреваю, что они будут постоянно с вами спорить об этом, но на самом деле это просто слова, которые вы используете.