Переключение на Главную Страницу Страницы: 1 ОтправитьПечать
Обычная тема Генерация документации в Markdown стиле (число прочтений - 4025 )
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Генерация документации в Markdown стиле
30. Апреля 2008 :: 12:54
Печать  
Накидал скрип для создания документации на основании спец.меток в модулях.
За основу взята разметка в стиле Markdown.

пример прилагается. в т.ч. приложил найденное в сети описание формата.

сделано не оптимально, но работает.
сейчас есть проблема с формированием кода при выгрузке (тег code), убирает ведущие пробелы
Для работы скрипта необходимо создать в каталоге иб папки: Documentation\txt, Documentation\html

дополняю, как просили в 1.

пример документации в ГМ:

Код
Выбрать все
//! #Глобальный модуль
//! ##Описание процедур и функций
//!
//i какой-то текст
//!
//! - список 1
//! - список 2
//! - список 3
//!  - список 3.1
//! Пример кода:
//! <pre>
//! <code>
//! Функция глФрмСистема(пЗначение)
//! 	Возврат Формат(пЗначение,"Ч19.2"+Разделитель);
//! КонецФункции;
//! </code>
//! </pre>
//! >цитата 1  
//! >цитата 2
//! >>цитата 2.1
//!
//! продолжим описание ГМ  
//!
//! продолжим описание ГМ 2
//! Снова Заголовок 1 уровня
//i ===
 

« Последняя редакция: 26. Июня 2008 :: 08:53 - Phoenix »  

DocumentatorByMarkdown.zip ( 239 KB | Загрузки )

Лень двигатель прогресса.&&http://www.itpath.ru&&;
Наверх
IP записан
 
trdm
1c++ power user
qt1l developer
1c++ moderator
Отсутствует



Сообщений: 2343
Местоположение: г. Ростов-на-Дону
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: Генерация документации в Markdown стиле
Ответ #1 - 30. Апреля 2008 :: 12:56
Печать  
ты бы развернутое описание дал прямо тут...
  
Наверх
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: Генерация документации в Markdown стиле
Ответ #2 - 26. Июня 2008 :: 08:55
Печать  
Обновил скрипт.
Появилась возможность создать пользовательскую и техническую документацию (различные теги)
Исправлены найденные ошибки
пример
Код
Выбрать все
	//tech Создаем структуру ТЧ 2
	//i Создаем структуру ТЧ 2
 

  

Лень двигатель прогресса.&&http://www.itpath.ru&&;
Наверх
IP записан
 
ildary
Full Member
***
Отсутствует



Сообщений: 163
Зарегистрирован: 24. Марта 2008
Re: Генерация документации в Markdown стиле
Ответ #3 - 04. Июля 2008 :: 08:24
Печать  
trdm писал(а) 30. Апреля 2008 :: 12:56:
ты бы развернутое описание дал прямо тут...


А я бы хотел узнать о приактической пользе этой штуки.
  
Наверх
 
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: Генерация документации в Markdown стиле
Ответ #4 - 07. Июля 2008 :: 07:53
Печать  
Польза
- создание прототипа документации для пользователей.
- документирование кода, для упрощения понимания и доработки.
Как пример: добавил подобное описание к модулю, сформировал документацию, отдал админам 1С, чтобы не приставали с вопросами: а как получается то или это ...
  

Лень двигатель прогресса.&&http://www.itpath.ru&&;
Наверх
IP записан
 
ildary
Full Member
***
Отсутствует



Сообщений: 163
Зарегистрирован: 24. Марта 2008
Re: Генерация документации в Markdown стиле
Ответ #5 - 10. Июля 2008 :: 08:48
Печать  
Phoenix писал(а) 07. Июля 2008 :: 07:53:
Польза
- создание прототипа документации для пользователей.
- документирование кода, для упрощения понимания и доработки.
Как пример: добавил подобное описание к модулю, сформировал документацию, отдал админам 1С, чтобы не приставали с вопросами: а как получается то или это ...


Может я что-то недопонимаю, но ИМХО лучше писать читабельный текст программы (форматирование, отступы, понятные имена переменных), и не потребуется отдельное документирование. Лично я совершенно забил на документирование с выходом scicolorer - главное написать текст так, чтобы он при сворачивании сам себя документировал.
  
Наверх
 
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: Генерация документации в Markdown стиле
Ответ #6 - 10. Июля 2008 :: 10:34
Печать  
читать код умеют лишь те, кто так или иначе знаком с программированием и назначением тех или иных методов языка.
у нас есть четкое разделение - разработчик и админ.
админы читать код не умеют. и конфиг всегда занят. а админов много.
опять же, пока документируешь - заново простраиваешь логику.
  

Лень двигатель прогресса.&&http://www.itpath.ru&&;
Наверх
IP записан
 
Переключение на Главную Страницу Страницы: 1
ОтправитьПечать