Переключение на Главную Страницу Страницы: 1 [2] 3 4  ОтправитьПечать
Очень популярная тема (более 25 ответов) XML и ALS–документация по классам (число прочтений - 11137 )
JohnyDeath
1c++ power user
1c++ donor
Отсутствует



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #15 - 17. Октября 2008 :: 06:27
Печать  
artbear писал(а) 17. Октября 2008 :: 06:18:
JohnyDeath писал(а) 17. Октября 2008 :: 06:15:
CaBaT писал(а) 17. Октября 2008 :: 05:59:
JohnyDeath писал(а) 17. Октября 2008 :: 05:50:
В душе теплилась надежда, что это уже давно есть...

может конечно я не нашёл просто...

а вообще была шальная мысль написать скриптик для выдирания тегов из классов через GComp, только фиг знает когда руки дойдут, поэтому пока остановился на описанном выше варианте.

Подумалось:
1. Есть методы для создания ALS из prm
2. Есть возможность брать код конкретной обработки/класса (тот же ВМ)
Может можно будет сделать так, чтобы ALS создавался сразу из обработки?

Задумывался над этим.
1. Пока нет простой возможности получать текст произвольной обработки или класса.
Хотя для класса можно добавить встроенный метод КОП::CreateALS(ФлагИзМодуля =1, ФлагИзПрмФайла = 0) - который работает аналогично MetaInfoClasses::CreateALS

Над сложностью этой разработки не задумывался.

Сделать хотя бы возможность создавать ALS не из prm, а прям из текста. Вот примерно так себе это вижу:
Код
Выбрать все
ТекстКласса=РасширениеФормы.ТекстМодуля;
MetaInfoClasses.CreateALSизТекста(ТекстКласса); 

  
Наверх
 
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

Сообщений: 398
Местоположение: Москва
Зарегистрирован: 15. Июня 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #16 - 17. Октября 2008 :: 06:44
Печать  
OpenConf + script's никто не отменял.
распрасить модуль, выдернуть все проц/функ - не проблема.
примеров полно.
  

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


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

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #17 - 17. Октября 2008 :: 06:46
Печать  
JohnyDeath писал(а) 17. Октября 2008 :: 06:27:
Сделать хотя бы возможность создавать ALS не из prm, а прям из текста. Вот примерно так себе это вижу:
Код
Выбрать все
MetaInfoClasses.CreateALSизТекста(ТекстКласса); 


Да, ИМХО это можно сделать в 1С++ без проблем Улыбка
Пиши в багзиллу.
  

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


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

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

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



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

ОФФ: млин, с этим переездом багзиллы придётся новый аккаунт создавать
  
Наверх
 
IP записан
 
JohnyDeath
1c++ power user
1c++ donor
Отсутствует



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #20 - 17. Октября 2008 :: 07:02
Печать  
artbear писал(а) 17. Октября 2008 :: 06:46:
JohnyDeath писал(а) 17. Октября 2008 :: 06:27:
Сделать хотя бы возможность создавать ALS не из prm, а прям из текста. Вот примерно так себе это вижу:
Код
Выбрать все
MetaInfoClasses.CreateALSизТекста(ТекстКласса); 


Да, ИМХО это можно сделать в 1С++ без проблем Улыбка
Пиши в багзиллу.

Очень довольный
Готово
  
Наверх
 
IP записан
 
JohnyDeath
1c++ power user
1c++ donor
Отсутствует



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #21 - 17. Октября 2008 :: 07:43
Печать  
Phoenix писал(а) 17. Октября 2008 :: 06:44:
OpenConf + script's никто не отменял.
распрасить модуль, выдернуть все проц/функ - не проблема.
примеров полно.

А можешь показать? я нашёл только "...\Разное\ValidateXmlComments.js" но я не пойму как он работает  Нерешительный (у меня он, по-моему, вообще не работает).
И ещё: был бы скрипт по добавлению этих комментов - вообще лафа была б.
Например, я нажимаю хоткей, мне вылазиет окно, где я должен заполнить имя метода, параметры и т.д. по списку (, которого почему-то ни у кого нет, хотя многие пишут "правильно"). После заполнения в модуль формы в текущую строку уже падает "нормальный" текст для последующего парсинга. Такое вообще реально сделать. Тут скорее всего вся сложность в том самом окне, где надо вносить данные, т.е. хочется сразу всё в одном окне.
  
Наверх
 
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

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

ОФФ: млин, с этим переездом багзиллы придётся новый аккаунт создавать

нет, ничего подробней не нашел, но и этого достаточно.
сделать скрипт для заполнения информации по тэгам возможно. смотри скрипт Авторские комментарии, там динамически генерится html страница, заполняются данные, которые потом пишутся в реестр.
пока что сам не особо использую описание классов, описал только 1 свой класс. в остальных случаях пока не было необходимости.
базис документации хранится в модуле. для этого использую свой скрипт DocumentationMarkdownStyle.js (лежит в разделе репозитарий).
+ каждое изменение идет по конкретной задаче, в коде: пишется коммент с номером задачи.
  

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



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

ОФФ: млин, с этим переездом багзиллы придётся новый аккаунт создавать

нет, ничего подробней не нашел, но и этого достаточно.
сделать скрипт для заполнения информации по тэгам возможно. смотри скрипт Авторские комментарии, там динамически генерится html страница, заполняются данные, которые потом пишутся в реестр.
пока что сам не особо использую описание классов, описал только 1 свой класс. в остальных случаях пока не было необходимости.
базис документации хранится в модуле. для этого использую свой скрипт DocumentationMarkdownStyle.js (лежит в разделе репозитарий).
+ каждое изменение идет по конкретной задаче, в коде: пишется коммент с номером задачи.

А чего ЭТОГО достаточно? то, что я в 0-м посте написал?
Только что скачал http://1c.alterplast.ru/files/ocs/ocs_last.dos.zip там твоего скрипта DocumentationMarkdownStyle.js нет.
  
Наверх
 
IP записан
 
Phoenix
Senior Member
****
Отсутствует


itpath.ru

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

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


itpath.ru

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

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



Сообщений: 3050
Местоположение: Волгоград
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #26 - 17. Октября 2008 :: 11:18
Печать  
Phoenix писал(а) 17. Октября 2008 :: 11:10:
да нет, т.к. не пользуюсь репозитарием.
надо на форуме брать.
если честно, мне того описания хватило, базовый английский помог Улыбка

Ну что в том описании етсь, то я тоже понял
Цитата:
А где можно поподробнее почитать про эти тэги? Или может кто-то разъяснит. Вот например здесь:
Цитата:
/// <param name="Число" mod="[in] | [out]" type="чПарам1" defaultValue = "1">Параметр первый</param>

можно логически догодаться что есть что, но как мне узнать все эти "defaultValue", "mod" и "type"? Откуда вы берёте этот список?

Просто хотелось бы наиболее полное описание: где какие параметри могут быть, какие значения и т.д.

А можешь хотябы этот скрипт сюда положить "на посмотреть"?
  
Наверх
 
IP записан
 
artbear
1c++ developer
1c++ moderator
Отсутствует


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

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #27 - 17. Октября 2008 :: 11:23
Печать  
Насколько я понимаю, эти теги просто будут переноситься в алс-файл как есть.
Т.е. ограничений особо сильных нету.
  

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


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

Сообщений: 6303
Местоположение: Москва
Зарегистрирован: 19. Мая 2006
Пол: Мужской
Re: XML и ALS–документация по классам
Ответ #28 - 17. Октября 2008 :: 11:35
Печать  
Добавлю, что в исходниках есть предопределенные значения тегов
Цитата:
  m_strNameSpace    = L"namespace";
  m_strNameClass    = L"class";
  m_strNameMethod   = L"method";
  m_strNameProperty = L"property";
  m_strNameNames    = L"name";
  m_strNameParam    = L"param";
  m_strNameReturns  = L"returns";

По ним идет отдельный анализ и конструирование алс-файла.
Остальные значения идут в составе этих тегов или делаются отдельно.
  

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–документация по классам
Ответ #29 - 17. Октября 2008 :: 11:38
Печать  
Ну это и в описании есть:
Цитата:
НастройкаALS(<?>)
Синтаксис:
rNameNames>,<strNameParam>,<strNameReturns>)
Назначение:
настраивает названия тэгов для выгрузки XML-описании классов в als-файл
Параметры:
<strNameSpace> - (Строка)  Пространство имен (по умолчанию namespace). Этот тэг формирует папку в синтаксис помощнике 1С;
<strNameClass> - (Строка)  Класс (по умолчанию class) Этот тэг формирует папку в синтаксис помощнике 1С
<strNameMethod> - (Строка)  Метод (по умолчанию method)
<strNameProperty> - (Строка)  Свойство (по умолчанию property);
<strNameNames> - (Строка)  У всех выше описанных тэгов, кроме возвращаемого значения, обязан быть атрибут имя (по умолчанию name);
<strNameParam> - (Строка)  Параметр метода (по умолчанию param)
<strNameReturns> - (Строка)  Возвращаемое значение (по умолчанию returns)


короче, я так понял, дело мутное. Ладно, будем делать на том, что есть.
Phoenix, выложи, пжлст, скрипт.
  
Наверх
 
IP записан
 
Переключение на Главную Страницу Страницы: 1 [2] 3 4 
ОтправитьПечать