1С++ users forum - Редактор для составления документации

(UTC)

1С++ users forum › 1С++ и прочие расширения v7 › Курилка › Редактор для составления документации

(Группа Модераторов: 1c++ moderator)

‹ Предыдущая Тема | Следующая Тема ›

Переключение на Главную Страницу

Страницы: [1] 2

Отправить

Горячая тема (более 10 ответов)

Редактор для составления документации (число прочтений - 4852 )

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Редактор для составления документации 29. Марта 2008 :: 13:41	Печать
	Всем привет. Нужно написать документацию по API для внешней компоненты, т.е. объекты, свойства и методы объектов, доступные из 1С-ки. Ищу подходящий для этой цели редактор с возможностью генерации переходов (ссылок) по разделам и, если это возможно, заданием графической схемы (наследования например). В разделе "Документация" почитал о применяемом разработчиками 1C++ способе компиляции документации. В принципе выходная форма подходит. Есть ли какое-нибудь GUI-средство для составления документации в формате reStructuredText? Какие еще есть средства для составления документации?


	ICQ IP записан

trdm 1c++ power user qt1l developer 1c++ moderator Отсутствует Сообщений: 2344 Местоположение: г. Ростов-на-Дону Зарегистрирован: 19. Мая 2006 Пол:	Re: Редактор для составления документации Ответ #1 - 29. Марта 2008 :: 14:22	Печать
	доксиген, но только в том случае если пишешь нормальные комменты и в нужном формате в src.


	Skype/VoIP ICQ IP записан

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Re: Редактор для составления документации Ответ #2 - 31. Марта 2008 :: 14:01	Печать
	trdm писал(а) 29. Марта 2008 :: 14:22: доксиген, но только в том случае если пишешь нормальные комменты и в нужном формате в src. Доксиген не подходит. Мне нужно составить API на этапе проектирования, т.е. когда кода еще нет. Я работал немного в Power Designer 12 - как редактор подходит вполне, но с отчетами плохо, стандартный отчет выводит совсем не ту информацию, которая нужна. Мне подходит формат документации по 1С++, вот только бы редактор подходящий найти .


	ICQ IP записан

trdm 1c++ power user qt1l developer 1c++ moderator Отсутствует Сообщений: 2344 Местоположение: г. Ростов-на-Дону Зарегистрирован: 19. Мая 2006 Пол:	Re: Редактор для составления документации Ответ #3 - 31. Марта 2008 :: 16:31	Печать
	Thor писал(а) 31. Марта 2008 :: 14:01: Доксиген не подходит. Мне нужно составить API на этапе проектирования, т.е. когда кода еще нет. Я работал немного в Power Designer 12 - как редактор подходит вполне, но с отчетами плохо, стандартный отчет выводит совсем не ту информацию, которая нужна. Мне подходит формат документации по 1С++, вот только бы редактор подходящий найти . тады какой-нить Visual UML а потом доксиген


	Skype/VoIP ICQ IP записан

fez Forum Administrator 1c++ power user Отсутствует I wanted to cry, but the tears wouldn't come Сообщений: 2712 Зарегистрирован: 19. Мая 2006 Пол:	Re: Редактор для составления документации Ответ #4 - 31. Марта 2008 :: 16:41	Печать
	Совсем разучились интернетом пользоваться... http://www.google.ru/search?hl=en&q=reStructuredText+editor&btnG=Google+Search&l... первая и вторая ссылки. P.S. Поэтичное название у программы по первой ссылке...

	http://fezeev.livejournal.com/
	www IP записан

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Re: Редактор для составления документации Ответ #5 - 01. Апреля 2008 :: 07:19	Печать
	fez писал(а) 31. Марта 2008 :: 16:41: Совсем разучились интернетом пользоваться... http://www.google.ru/search?hl=en&q=reStructuredText+editor&btnG=Google+Search&l... первая и вторая ссылки. P.S. Поэтичное название у программы по первой ссылке... Скачал, разархивировал. И как сие чудо запускать? Судя по скриншоту - тот же текстовый редактор с возможностью предпросмотра.


	ICQ IP записан

kms 1c++ power user 1c++ moderator Отсутствует я хочу, чтоб сюда проложили дорогу оттуда... Сообщений: 4632 Зарегистрирован: 19. Мая 2006	Re: Редактор для составления документации Ответ #6 - 01. Апреля 2008 :: 07:45	Печать
	Thor В принципе, rst - несложный формат, редактор не особо нужен, если набить руку.

	De quelle planète es-tu?
	IP записан

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Re: Редактор для составления документации Ответ #7 - 01. Апреля 2008 :: 08:07	Печать
	kms писал(а) 01. Апреля 2008 :: 07:45: Thor В принципе, rst - несложный формат, редактор не особо нужен, если набить руку. С таким же успехом я могу в Ворде набрать. Я так в принципе и делал до сих пор. Периодически борясь с форматированием. А в принципе хотелось бы так: добавить узел "МойПрикладнойОбъект" - заполнить параметры - добавить узел "СвойствоМоегоОбъекта" - заполнить параметры и т.д. Затем задать схему форматирования и вывести на печать. Что-то типа als-редактора.


	ICQ IP записан

kms 1c++ power user 1c++ moderator Отсутствует я хочу, чтоб сюда проложили дорогу оттуда... Сообщений: 4632 Зарегистрирован: 19. Мая 2006	Re: Редактор для составления документации Ответ #8 - 01. Апреля 2008 :: 08:27	Печать
	Ну, rst лучше именно тем, что формат простой и позволяет легко транслировать в другие форматы - html, chm, pdf, xml и т.д. Но я тебя понял - и ты совершенно прав. Мне лично редактор особо никогда нужен не был, а вот стандартизация составления документации - была нужна. Формат должен быть четко прописан. Но в 1cpp добиться этого не удалось, а может и я не особо старался. В итоге, к примеру, выгрузить документацию 1cpp в xml с последующим разбором - не получается без скрипа, форматы описания разные для разных классов. Короче, согласен, формат надо фиксировать, любым спобосом. Можно и каким-то редактором, но скорее всего, надо написать что-то свое, благо формат очень простой (а существующих редакторов я таких не видел). P.S. Но, кстати, это все про rst - а я не сильно уверен, что это именно то, что тебе нужно. Для моделирования может и не лучший вариант - возможно и правда стоит смотреть на схемы UML в каком-то виде.

	De quelle planète es-tu?
	IP записан

fez Forum Administrator 1c++ power user Отсутствует I wanted to cry, but the tears wouldn't come Сообщений: 2712 Зарегистрирован: 19. Мая 2006 Пол:	Re: Редактор для составления документации Ответ #9 - 01. Апреля 2008 :: 09:42	Печать
	Thor писал(а) 01. Апреля 2008 :: 07:19: Скачал, разархивировал. И как сие чудо запускать? Оно вроде на питоне написано. Ну и ридми там разве нету, чтобы почитать? Цитата: Судя по скриншоту - тот же текстовый редактор с возможностью предпросмотра. А ты чего ждал?

	http://fezeev.livejournal.com/
	www IP записан

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Re: Редактор для составления документации Ответ #10 - 01. Апреля 2008 :: 12:28	Печать
	fez писал(а) 01. Апреля 2008 :: 09:42: Thor писал(а) 01. Апреля 2008 :: 07:19: Скачал, разархивировал. И как сие чудо запускать? Оно вроде на питоне написано. Ну и ридми там разве нету, чтобы почитать? Цитата: Судя по скриншоту - тот же текстовый редактор с возможностью предпросмотра. А ты чего ждал? Цитата: Requirements ------------ There are no special requirements for running ReSTedit. From version 0.2 it ships as a standalone application which should be running on any Mac OS X 10.2 or higher. As it comes with full source code you can build ReSTedit yourself, if you have Apple's developer tools installed, plus some Python interpreter version 2.2 or higher, plus PyObjC 1.0b [3]_ or higher.


	ICQ IP записан

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Re: Редактор для составления документации Ответ #11 - 01. Апреля 2008 :: 12:38	Печать
	kms Полностью с тобой согласен. Хотел писать что-то свое, но сначала решил спросить.


	ICQ IP записан

fez Forum Administrator 1c++ power user Отсутствует I wanted to cry, but the tears wouldn't come Сообщений: 2712 Зарегистрирован: 19. Мая 2006 Пол:	Re: Редактор для составления документации Ответ #12 - 01. Апреля 2008 :: 12:38	Печать
	Thor писал(а) 01. Апреля 2008 :: 12:28: plus some Python interpreter version 2.2 or higher, plus PyObjC 1.0b [3]_ or higher. поставь питона и PyObjC - чего неясно-то?

	http://fezeev.livejournal.com/
	www IP записан

Thor Junior Member Отсутствует I Love YaBB 2! Сообщений: 82 Зарегистрирован: 12. Июля 2006	Re: Редактор для составления документации Ответ #13 - 01. Апреля 2008 :: 13:03	Печать
	fez писал(а) 01. Апреля 2008 :: 12:38: Thor писал(а) 01. Апреля 2008 :: 12:28: plus some Python interpreter version 2.2 or higher, plus PyObjC 1.0b [3]_ or higher. поставь питона и PyObjC - чего неясно-то? Как насчет Цитата: running on any Mac OS X 10.2 or higher и Цитата: The PyObjC project aims to provide a bridge between the Python and Objective-C programming languages ?


	ICQ IP записан

fez Forum Administrator 1c++ power user Отсутствует I wanted to cry, but the tears wouldn't come Сообщений: 2712 Зарегистрирован: 19. Мая 2006 Пол:	Re: Редактор для составления документации Ответ #14 - 01. Апреля 2008 :: 13:43	Печать
	Уболтал, чертяка языкастая.

	http://fezeev.livejournal.com/
	www IP записан

Переключение на Главную Страницу

Страницы: [1] 2

Отправить

‹ Предыдущая Тема | Следующая Тема ›

« Главная ‹ Раздел Вверх

Вверх

Valid XHTML

Valid CSS

Powered by Perl

Source Forge