Статьи

Многоязычный инструмент для документирования

С прекрасной статьей Дэвида Хеккера о документации, работающей на SitePoint, казалось своевременным представить интересный инструмент документации с открытым исходным кодом, который объединяет 14 языков программирования.

Natural Docs, который можно найти в Sourceforge , включает поддержку C ++, C #, Java, JavaScript, Perl, PHP, Python, PL / SQL, Visual Basic, Pascal, Tcl, Ada, Ruby и Assembly.

Целью этого проекта является внедрение средств автоматизации, которые позволяют легко создавать HTML-документацию и, как следствие, легко читаемую отправную точку для окончательного оформления пакета документации всего проекта.

Дорожная карта для этого проекта является надежной, включая расширенную поддержку указанных языков, возможность перехода с других платформ документации (например, JavaDoc), возможность вывода в PDF, а также HTML, и, наконец, позволяет пользователям создавать собственные файлы настроек для управления выводом Natural Docs.

Интересная особенность Natural Docs заключается в том, что он может позволить разработчикам, которые могут работать с Java в Unix (используя JavaDoc) и работать с Visual Basic или C # в Windows (используя проприетарный или другой инструмент документирования), стандартизировать на одной платформе документации.

Мне было бы интересно услышать, какие инструменты документации используют читатели SitePoint.