Встает постоянно вопрос о документировании разработок, может выработаем некую единую систему.
Тема уже обсуждалась в разных ветках, но вроде четкого решения не было.

Решить в каком формате описывать
1) модули 1с стандартные
2) классы:
а- собственно сами классы
б- свойства
в- методы

Хорошо бы что помимо стандартного набора была возможность группировки функций (ключевые слова что ли,  к каким подсистемам относится метод).

Причем интересует даже не столько формат хранения документации, а набор необходимых характеристик.

Какую цель ставил, когда тему заводил:
* определить СТАНДАРТ ДОКУМЕНТИРОВАНИЯ модулей 1с стандартных и классов
* на основе этого стандарта сделать плагин к опенконфу в виде html-формы с заполнением необходимых полей - я берусь за эту задачу
* сделать парсер модулей, который будет собирать описания во внешний файл в формате xml
* из xml можно будет с помощью xslt  конвертировать в разные форматы

У Роберта уже есть такие наработки, он по такой схеме вроде и работает http://www.1cpp.ru/forum/YaBB.pl?num=1162249850/39#39 .

Код на cpp я бы документировал с помощью doxygen.
Основной смысл - в автоматическом построении диаграмм использования и иерархий классов.

Можно ли прикрутить к 1С - не задумывался.
Вроде кто-то брался, чем кончилось - не знаю.

P.S.
На самом деле в том же 1cpp - х.р разберешься без банки водки.
Наверное, в этом (отсутствии документации кода) есть глубокий смысл, но я не знаю какой

Начал смотреть разные системы: http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

Пока вот эта больше всего понравилась: http://en.wikipedia.org/wiki/Comparison_of_documentation_generators.

Может выложит кто конкретные варианты? У кого помимо стандартного 1с-ных комментов "Функция...Параметры...Возвращаемое значение" еще что используется...

Хорошая идея разделять комменты
- для разработчиков
- для пользователей - чтоб в доку для пользователей нюансы использования можно было экспортировать

Изучаю дальше, сформирую потом формат выложу свой вариант для обсуждения. Но описывать правила заполнения немало придется...