Vit (11.11.2007 19:57, просмотров: 192) ответил Evgeny_CD на Система скрытых тегов в исходниках - как бы такое залудить?
А по-конкретнее, чего получить на выходе желаемо? Возьмём для примера советский ГОСТ на ПО (что-то из 19-й серии) - там есть спецификация. Как и для железа, для программ оно якобы есть основной документ. В головную спецификацию могут входить составными частями продукты с известными спецификациями (причём по номенклатуре можно определить изготовителя) и прочее. Причём доработанный болт всё-же идёт под местной спецификацией, а не исходно, но на неё ссылка может быть (в нижнем слое;).
Назначение, область и способы применения идут в отдельных документах "описание программы" (тоже есть ГОСТ). Причём часть параметров определяется ТЗ.
Если цель - построить текущую документацию из независимых кусков, но одним махом, то это осязаемо. Если нужно документировать нечто универсальное, то нужно где-то остановиться. Если узнавать "что же там аффтар задумал в реальности", то можно зарыться.
Я (могу сказать что с недавнего времени только) когда пишу дрова (BSP), разделяю хидера на те, которые для потребителя, и те, которые привязывают иные дрова из BSP, и те, которые включают внешние либы. Документирование более-менее наличествующее прокладывается в хидер для юзера. В остальных местах только комменты. BSP компилится в свою очередь в либу. Файл конфига (для информации) выкладывается рядом и если чего сделать не по нему будет страшная ругань;)
Я просто не совсем понимаю - вот API - оно описано и должно работать.
Вот блок кода (дров), который нужно добавить - он пишется одним человеком (количество может быть другим), а включается в BSP другим. Внутри либа, снаружи хидер с некоторым документированием - оно описано и должно работать.
Пока шире не придумывается.