Переключение на Главную Страницу Страницы: 1 2 [3] 4  ОтправитьПечать
Очень популярная тема (более 25 ответов) XML и ALS–документация по классам (число прочтений - 11138 )
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #30 - 17. Октября 2008 :: 11:39
Печать  
Цитата:
Просто хотелось бы наиболее полное описание: где какие параметри могут быть, какие значения и т.д.

А можешь хотябы этот скрипт сюда положить "на посмотреть"?

  

DocsByMarkdownStyle.zip ( 43 KB | Загрузки )

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


Эх, дайте что-нибудь новенькое
да полезное потести

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #31 - 17. Октября 2008 :: 11:52
Печать  
Вот реальный пример, только что проверил.
Цитата:
///<namespace name = "Классы общего назначения">
///<class name = "ОбщиеМетоды">
Класс ОбщиеМетоды = ОбщиеМетоды.txt
{
     ///<method name = "Сравнить" Тип = "Число">
     ///<Синтаксис>Сравнить(П1, П2)</Синтаксис>
     ///<param name = "П1">Первое значения для сравнения</param>
     ///<param name = "П2">Второе значения для сравнения</param>
     ///<returns type = "Число"> 1 если значения совпадают, 0 - если не совпадают.</returns>
     ///<Описание> Сравнивает П1 и П2 на предмет равенства. Если типы различны, то не равно.
     ///Если П1 и П2 - строки, то они обрезаются справа</Описание>
     ///<sig>
     Число Сравнить(Неопределеный П1, Неопределеный П2);
     ///</sig>
     ///</method>
};
///</class>
///</namespace>

Результат работы метода - копия из синтакс-помощника
Цитата:
Сравнить(<?>,)
Сравнить(<?>,)
Тип
Число
Синтаксис
Сравнить(П1, П2)
Параметры
• < name="П1" >
Первое значения для сравнения
• < name="П2" >
Второе значения для сравнения
Возвращаемое значение
• < type="Число" >
1 если значения совпадают, 0 - если не совпадают.
Описание
Сравнивает П1 и П2 на предмет равенства. Если типы различны, то не равно.
Если П1 и П2 - строки, то они обрезаются справа
sig
Число Сравнить(Неопределеный П1, Неопределеный П2);


Т.е. все результаты видны и все довольно просто.
Думаю, что тебе этого хватит.
  

OpenConf developer :: http://openconf.1cpp.ru&&FormEx developer :: http://formex.dorex.ru&&1C++ active developer &amp;&amp; tester :: www.1cpp.ru
Наверх
GTalkSkype/VoIPICQ  
IP записан
 
JohnyDeath
1c++ power user
1c++ donor
Отсутствует



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #32 - 17. Октября 2008 :: 11:55
Печать  
Phoenix писал(а) 17. Октября 2008 :: 11:39:

Спасибо. А можно краткий ликбез "хау ту"?
И ещё один вопрос ко всем скриптописателям: в какой среде вы их пишите/отлаживаете. Не в блокноте ж.
  
Наверх
 
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #33 - 17. Октября 2008 :: 11:55
Печать  
artbear писал(а) 17. Октября 2008 :: 11:52:
Вот реальный пример, только что проверил.
Цитата:
///<namespace name = "Классы общего назначения">
///<class name = "ОбщиеМетоды">
Класс ОбщиеМетоды = ОбщиеМетоды.txt
{
     ///<method name = "Сравнить" Тип = "Число">
     ///<Синтаксис>Сравнить(П1, П2)</Синтаксис>
     ///<param name = "П1">Первое значения для сравнения</param>
     ///<param name = "П2">Второе значения для сравнения</param>
     ///<returns type = "Число"> 1 если значения совпадают, 0 - если не совпадают.</returns>
     ///<Описание> Сравнивает П1 и П2 на предмет равенства. Если типы различны, то не равно.
     ///Если П1 и П2 - строки, то они обрезаются справа</Описание>
     ///<sig>
     Число Сравнить(Неопределеный П1, Неопределеный П2);
     ///</sig>
     ///</method>
};
///</class>
///</namespace>

Результат работы метода - копия из синтакс-помощника
Цитата:
Сравнить(<?>,)
Сравнить(<?>,)
Тип
Число
Синтаксис
Сравнить(П1, П2)
Параметры
• < name="П1" >
Первое значения для сравнения
• < name="П2" >
Второе значения для сравнения
Возвращаемое значение
• < type="Число" >
1 если значения совпадают, 0 - если не совпадают.
Описание
Сравнивает П1 и П2 на предмет равенства. Если типы различны, то не равно.
Если П1 и П2 - строки, то они обрезаются справа
sig
Число Сравнить(Неопределеный П1, Неопределеный П2);


Т.е. все результаты видны и все довольно просто.
Думаю, что тебе этого хватит.



если на основе этого сгенерить tls - описание к параметрам не будет подставляться когда курсор будет в разделе параметра.
  

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


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #34 - 17. Октября 2008 :: 11:57
Печать  
JohnyDeath писал(а) 17. Октября 2008 :: 11:55:
Phoenix писал(а) 17. Октября 2008 :: 11:39:

Спасибо. А можно краткий ликбез "хау ту"?
И ещё один вопрос ко всем скриптописателям: в какой среде вы их пишите/отлаживаете. Не в блокноте ж.


пример - лежит в архиве.
предпочитаю писать в wscite
  

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



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #35 - 17. Октября 2008 :: 11:57
Печать  
artbear писал(а) 17. Октября 2008 :: 11:52:
Вот реальный пример, только что проверил.

Т.е. все результаты видны и все довольно просто.
Думаю, что тебе этого хватит.

Да, спасибо, должно.
А что должно храниться в теге <sig>? Просто определение ф-ии?
  
Наверх
 
IP записан
 
artbear
1c++ developer
1c++ moderator
Отсутствует


Эх, дайте что-нибудь новенькое
да полезное потести

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #36 - 17. Октября 2008 :: 12:00
Печать  
JohnyDeath писал(а) 17. Октября 2008 :: 11:57:
artbear писал(а) 17. Октября 2008 :: 11:52:
Вот реальный пример, только что проверил.

Т.е. все результаты видны и все довольно просто.
Думаю, что тебе этого хватит.

Да, спасибо, должно.
А что должно храниться в теге <sig>? Просто определение ф-ии?

Так вся фишка и состоит в том, что этот тег абсолютно произвольный Улыбка и ничем не регулируется.
Список зарезервированных тегов я тебе дал выше.
Например, можешь вместо тега <sig> писать <Сигнатура> или <Порядок_Вызова> Улыбка
  

OpenConf developer :: http://openconf.1cpp.ru&&FormEx developer :: http://formex.dorex.ru&&1C++ active developer &amp;&amp; tester :: www.1cpp.ru
Наверх
GTalkSkype/VoIPICQ  
IP записан
 
JohnyDeath
1c++ power user
1c++ donor
Отсутствует



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #37 - 17. Октября 2008 :: 12:02
Печать  
Phoenix писал(а) 17. Октября 2008 :: 11:57:
JohnyDeath писал(а) 17. Октября 2008 :: 11:55:
Phoenix писал(а) 17. Октября 2008 :: 11:39:

Спасибо. А можно краткий ликбез "хау ту"?
И ещё один вопрос ко всем скриптописателям: в какой среде вы их пишите/отлаживаете. Не в блокноте ж.


пример - лежит в архиве.

Я немного туповат в этом вопросе. Можешь рассказать как и где его запускать? На prm, на ert?
generateDocAll я так понимаю генерирует все виды доков.
а что InsertTag делает? как ввызывать?
Уж извиняй за назойливость, но хочется разобраться раз и навсегда.
  
Наверх
 
IP записан
 
artbear
1c++ developer
1c++ moderator
Отсутствует


Эх, дайте что-нибудь новенькое
да полезное потести

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #38 - 17. Октября 2008 :: 12:02
Печать  
Phoenix писал(а) 17. Октября 2008 :: 11:55:
если на основе этого сгенерить tls - описание к параметрам не будет подставляться когда курсор будет в разделе параметра.

В чем ошибка?
  

OpenConf developer :: http://openconf.1cpp.ru&&FormEx developer :: http://formex.dorex.ru&&1C++ active developer &amp;&amp; tester :: www.1cpp.ru
Наверх
GTalkSkype/VoIPICQ  
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #39 - 17. Октября 2008 :: 12:05
Печать  
artbear писал(а) 17. Октября 2008 :: 12:02:
Phoenix писал(а) 17. Октября 2008 :: 11:55:
если на основе этого сгенерить tls - описание к параметрам не будет подставляться когда курсор будет в разделе параметра.

В чем ошибка?

в наличии жирной точки перед параметром, которая ставит жирную точку в графе не подлежит использованию Улыбка
  

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


Эх, дайте что-нибудь новенькое
да полезное потести

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #40 - 17. Октября 2008 :: 12:08
Печать  
Phoenix писал(а) 17. Октября 2008 :: 12:05:
artbear писал(а) 17. Октября 2008 :: 12:02:
Phoenix писал(а) 17. Октября 2008 :: 11:55:
если на основе этого сгенерить tls - описание к параметрам не будет подставляться когда курсор будет в разделе параметра.

В чем ошибка?

в наличии жирной точки перед параметром, которая ставит жирную точку в графе не подлежит использованию Улыбка

И как/где исправить?
  

OpenConf developer :: http://openconf.1cpp.ru&&FormEx developer :: http://formex.dorex.ru&&1C++ active developer &amp;&amp; tester :: www.1cpp.ru
Наверх
GTalkSkype/VoIPICQ  
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #41 - 17. Октября 2008 :: 12:09
Печать  
это надо смотреть, сейчас пока не готов конкретно говорить по данной тематике, предлагаю на след.неделе.
  

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


Эх, дайте что-нибудь новенькое
да полезное потести

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #42 - 17. Октября 2008 :: 12:10
Печать  
С точкой я разобрался, все просто Улыбка, убрать не проблема.
Цитата:
strDest += (unsigned char)149;
strDest += " < ";
  

OpenConf developer :: http://openconf.1cpp.ru&&FormEx developer :: http://formex.dorex.ru&&1C++ active developer &amp;&amp; tester :: www.1cpp.ru
Наверх
GTalkSkype/VoIPICQ  
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #43 - 17. Октября 2008 :: 12:14
Печать  
Цитата:
Я немного туповат в этом вопросе. Можешь рассказать как и где его запускать? На prm, на ert?
generateDocAll я так понимаю генерирует все виды доков.
а что InsertTag делает? как ввызывать?
Уж извиняй за назойливость, но хочется разобраться раз и навсегда.

insertTag - вставляет тэг документатора, что-то типа шаблона.
для формирования документации запускаешь generateDoc... в тексте модуля, по которому хочешь составить документацию.
prm - пример использования тегом для генерации als
ерт - пример частично задокументированного модуля.
более подробно информацию можно найти в сети, опять же сейчас пока не поддерживается тег "---" и "===".
вместо двух пробелов для переноса нужно ставить "&&", опять же это написано в скрипте.
  

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


Эх, дайте что-нибудь новенькое
да полезное потести

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #44 - 17. Октября 2008 :: 12:18
Печать  
Кстати, подобный метод сделать в коде 1С не очень сложно.
ПРосто получить текст нужного модуля и вперед, с помощью КОМ-объекта IXMLDOMDocument легко генерить все, что нужно.
Код будет проще, чем в внутри С++

ЗЫ примеров работы с этим объектом много, даже для 1С - на мисте было вроде, например.
  

OpenConf developer :: http://openconf.1cpp.ru&&FormEx developer :: http://formex.dorex.ru&&1C++ active developer &amp;&amp; tester :: www.1cpp.ru
Наверх
GTalkSkype/VoIPICQ  
IP записан
 
Переключение на Главную Страницу Страницы: 1 2 [3] 4 
ОтправитьПечать