Информационное пространство дерева исходных текстов

Информация в исходном коде:

  1. Документирование самих исходных текстов: комментарии, встроенная документация
  2. Структура дерева каталогов и подразумеваемые файлы
  3. Собственно «документация»

Документирование исходных текстов

Задачи:

  1. Документирование исходного кода
  2. Создание технической документации «по месту»

Методы:

На примере Doxygen:

  1. Описания функций, макросов, классов…

  2. Диаграммы (вызовы, классы, кооперации, каталоги, зависимости…)

  3. Навигация по коду (индексы, подсветка синтаксиса, поиск…) и перекрёстные ссылки
  4. Специфика самого проекта и вспомогательные тексты
  5. Внешние объекты (напр., иллюстрации)
  6. Несколько выходных форматов для разных целей (HTML, XML, man, LaTeX, PS/PDF…)
  7. Использование размеченного текста (Markdown, HTML)

  8. ЯП: IDL, Java, C*, D, PHP, Python, Fortran, VHDL, VHDL

Python: самодокументируемость

Внешняя документация

Структура каталога с исходниками

Задачи:

Пример автоматического создания проекта: http://kdevelop.org/KDevelop

Д/З


pydoc sphinx

LecturesCMC/LinuxApplicationDevelopment2012/06 (last edited 2012-11-18 19:53:28 by FrBrGeorge)