Я искал приложение для редактирования документации по коду. Я имею в виду не просто инструмент генерации, такой как doxygen, а приложение, которое позволяет мне редактировать документацию и изменять ее непосредственно в коде.
Кто-нибудь знает хорошего редактора?
Спасибо!
Если вы говорите о Visual Studio...
Я написал надстройку AtomineerUtils Pro Documentation, которая очень поможет в создании и редактировании документации.
Для создания комментариев надстройка использует как можно больше информации из элемента кода, который вы документируете, чтобы заполнить для вас скелетный комментарий к документации. Он изо всех сил старается предоставить полезную информацию в удобочитаемой английской форме (поэтому пытается генерировать значимые документы и документирует множество вещей, которые не сразу «очевидны» из самого кода, например исключения, которые выдает метод)
Чтобы обновить комментарии, он может синхронизировать комментарий с кодом, поэтому, если вы добавляете/удаляете/переименовываете параметры, изменяете созданные исключения и т. д., он обновит комментарий, чтобы точно отразить новое состояние кода, который вы документируете.
Он применяет настраиваемый перенос слов, управление пробелами и форматирование блоков, чтобы блоки комментариев были аккуратными, хорошо сформированными и согласованными.
Он поддерживает множество языков (C++, C, C++/CLI, C#, Java, VB), стили форматирования документации Xml, Doxygen, Qt и JavaDoc,
Если вам нужна система документации, обеспечивающая редактирование документации по принципу WYSIWYG без приближения к исходному коду, то я думаю, что что-то более похожее на Document!X может лучше соответствовать вашим потребностям (я полагаю, что вам придется писать всю документацию самостоятельно, но он больше нацелен на создание внешней документации, чем на предоставление документации в коде)
Конечно, для вашего языка/платформы/редактора они могут быть неприменимы, но есть и другие подобные продукты, как только вы получите представление о том, какие ключевые слова для поиска использовать, так что, надеюсь, они могут дать вам некоторые наводки.
Используйте редактор кода и автоматически сверните тела функций, чтобы их не было видно. Это самый простой способ сделать то, что вы хотите сделать. К сожалению, вам также придется управлять контролем версий.
Проблема в том, что код (и комментарии) находится в системе управления версиями и его необходимо отслеживать. Вы не можете обойти это.
Как бы то ни было, вы видите логическую разницу между редактированием кода и комментариев, но вы редактируете одни и те же файлы. Программисты не видят разницы между этими вещами и будут действительно сбиты с толку вашей терминологией. Я подозреваю, что они тоже будут постоянно спорить с вами об этом, но на самом деле это просто слова, которые вы используете.
