[#] Создавая хтонических чудовищ, документируй
habrabot(difrex,1) — All
2016-12-27 17:30:04


![ioninja][1]

Под данным изречением, взятым с замечательной картинки-мема неизвестного (по крайней мере, мне) автора, поставит свою подпись каждый человек, имеющий хотя бы отдалённое отношение к программированию. **Весь вопрос, как?** Как именно документировать-то?



Нижележащий текст преследует несколько целей:


1. Во-первых, дать краткий обзор (читай — немного погундеть на тему) неудовлетворительного состояния инструментария, применимого к хтоническим чудовищам мира C/C++;
2. Во-вторых, предложить своё **альтернативное решение** (бесплатно-без-СМС-и-регистрации — проект некоммерческий и выложен на GitHub под MIT-лицензией);
3. В-третьих, призвать сообщество **пообщаться на тему** и собрать идеи;
4. В-четвёртых, пригласить **присоединиться к разработке** проекта на GitHub.

Сразу оговорюсь, что хотя проект создавался в первую очередь как альтернатива, а точнее, дополнение Doxygen для сишных и плюсовых API, архитектурно он в равной степени пригоден и **для других языков**. Это позволяет создавать порталы документации разноплановых библиотек — сами библиотеки могут быть написаны **на разных языках**, а в документации будет **единство стиля** во внешнем виде и поведении.





[Читать дальше →][2]

[1]: https://habrastorage.org/files/11c/a6c/b46/11ca6cb46335472bb4ebe4a67512e884.png
[2]: https://habrahabr.ru/post/318564/?utm_source=habrahabr&utm_medium=rss&utm_campaign=feed_posts#habracut