Разработка документации к продукту (а особенно если это библиотека или api) — важный процесс в разработке ИТ решений. Он нужен не только для других разработчиков или аналитиков, но и вам: вернувшись к коду через месяцы, будет проще понять что делали и зачем. Большую часть документации можно вести прямо в коде, и для этого есть несколько удобных инструментов:
- Doxygen — генерация документации из комментариев в коде (поддерживает C++, Qt, просто C, Python, Java и др.)
- Sphinx + Breathe — для Python-проектов с возможностью подключения C++ кода
- Natural Docs — лёгкий генератор с простым синтаксисом
- CppDoc — минималистичный инструмент для C++
- MkDocs — генератор документации на базе md файлов.

И с наличием такого количества инструментов я удивлен, что некоторые компании не могут мне дать инструкцию к своему api. Я планировал переработать приложение подключения к приборам с новыми крутыми библиотеками, но “магии apple” не случилось. Грустно? Нет, это печально 🤦‍♂️ в конечном итоге отрефакторил свою библиотеку под qt, используя его нативные типы данных и сигналы и в целом пока хватит. Сейчас выясню через wireshark управление dts и полноценный аналог avrdude готов (хотя прототип на python уже работает).