A2 & Oberon GOOGLE trans to English      Помощь      Поиск      Пользователи  Файловый архив


 Страниц (6): [1] 2 3 4 5 6 »   

> Описание: Инструмент для создание справочной системы
BohdanT Администратор
Отправлено: 01 Октября, 2008 - 20:05:16
Post Id



Super Member


Покинул форум
Сообщений всего: 606
Дата рег-ции: Июль 2008  
Откуда: Киев, Украина
Репутация: 2




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

Примеров куча, но я на вскидку вспомнил только, как сделано в KOL.
Может кто то посоветует что то. А то я давно хелпов не делал.
Интересно, как пример, подсмореть синтакис. Да и вообще можно для начала попробовать использовать сторонний инструмент Подмигивание
 
 Top
BohdanT Администратор
Отправлено: 03 Октября, 2008 - 14:01:10
Post Id



Super Member


Покинул форум
Сообщений всего: 606
Дата рег-ции: Июль 2008  
Откуда: Киев, Украина
Репутация: 2




На сколько я понял стандарт Javadoc стал общепринятым стандартом
Вот пример применения данной технологии к паскалю:
http://pasdoc.sourceforge.net/

хотя проще посмотреть статейку:
http://www.freepascal.ru/article.../20060301170731/
 
 Top
lit-uriy Супермодератор
Отправлено: 12 Ноября, 2008 - 03:51:12
Post Id


Advanced Member


Покинул форум
Сообщений всего: 298
Дата рег-ции: Нояб. 2008  
Откуда: Тюмень / Новосибирск
Репутация: 0




Есть проект на Qt, называется Doxygen (у нихстраница ссылок на другие системы), собственно ноги проекта растут из qdoc применяемой в трльтехе.

По поводу стандартов, есть два распространенных Qt doc (qdoc) и JavaDoc, я в основном в Doxygen'е комбинированым пользуюсь, вот стандартный сишный многострочный коментарий:
Цитата:

/*
*
*/

а вот в JavaDoc:
Цитата:

/**
*
*/

это qdoc, мне он меньше нравится:
Цитата:

/*!
*
*/

однако ключи (команды) мне больше подуше Кутявые
Цитата:

\file main.cpp

вместо Явовских:
Цитата:

@file main.cpp


и того:
Цитата:

/*!
* \file main.cpp
* \brief Пример использования класса YStdDelegate
* \framework{ Qt 4.3.4}
* \compiller{ GCC (MinGW32-gcc rev3.4.5)}
* \date 6.04.2008 8.04.2008
* \author Литкевич Юрий Иванович
*/


Вот мой пример тут на Qt4 (один пост с исходником другой со сгенереной документацией) можешь посмотреть как это в исходнике и как в документации (html)

Можно скачать doxygen и посмотреть там справку (виндовозный формат, и идейки от туда почерпнуть)

(Отредактировано автором: 12 Ноября, 2008 - 03:54:46)

 
 Top
BohdanT Администратор
Отправлено: 12 Ноября, 2008 - 13:32:36
Post Id



Super Member


Покинул форум
Сообщений всего: 606
Дата рег-ции: Июль 2008  
Откуда: Киев, Украина
Репутация: 2




Спасибо, посмотрел.
Красиво получается.

Сделал вывод, что работы немного больше, чем думал сначала. Радость

Получается, что нужно определять тип конструкции следующей после "\brief" и вдобавок парсить ее?

Нужно наверное сделать какие то шаблоны, для генерации Html.

Юра, а ты не мог бы сделать кокой-то тестовый модуль на обероне, что бы попробовать его парсить?

PS:
Коментарии qdoc мне тоже больше нравятся:
Цитата:

(*!
*)

Я думаю, что фичу с "*" в начале каждой строки пока может не делать? Улыбка
 
 Top
lit-uriy Супермодератор
Отправлено: 12 Ноября, 2008 - 16:02:47
Post Id


Advanced Member


Покинул форум
Сообщений всего: 298
Дата рег-ции: Нояб. 2008  
Откуда: Тюмень / Новосибирск
Репутация: 0




BohdanT, я к сожалению не знаю с какой стороны подойти к Эктив оберону.
Распарсить AOS'ные файлы не просто, т.к. содержат пользовательские коды UTF-8, хочу для начала переделать демку Qt'вую (TextEdit ), сделать там подсветку обероновскую.

Работать в winAOS мне не нравится - неудобно. Я постаянно парюсь с отрытием/сохранением файлов - непривычно, что нужно набирать имя/путь, чтобы что-то сохранить под другим именем.

По поводу документирования. Мне очень понравилась идея использовать коды UTF-8 из пользовательского пространства кодов вместо текста (doxygen) для создания тех или иных вещей (можно даже ссылки придумать).

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

PET - убожество его надо переделывать, но я не предствляю его архитектуру. Вообще давно хочу сделать програмерский редактор на движке "Сцинтила" пока не нашел ни одного удобного для меня. (IDE не люблю). Дак вот в рамках переделывания PET можно сделать и создание всякого рода ссылок, как в BlackBox (очень идея понравилась, но реализация тоже слабая)
(Добавление)
BohdanT пишет:
Получается, что нужно определять тип конструкции следующей после "\brief" и вдобавок парсить ее?

после ключа идет пробел и до точки, к стати я последнее время явным брифом не пользуюсь, я пользуюсь двумя ключами управления Doxygen'ом "Ява автобриф" и "Qt автобриф", тогда первая строка коментария считается за бриф.

Во вложении снимок PN2-го в котором я пишу код, и видна подсветка (в том числе DoxyGen'а) А также видно как я сейчас документирую код.

Дак вот можно было бы реализовать вместо писанины с ключами что-то более совершенное (в GCC это не прокатит так как он наотрез отказывается воспинимать многие коды из UTF-8, а Эктив Оберон ест это без запинки)

 
 Top
BohdanT Администратор
Отправлено: 12 Ноября, 2008 - 17:32:55
Post Id



Super Member


Покинул форум
Сообщений всего: 606
Дата рег-ции: Июль 2008  
Откуда: Киев, Украина
Репутация: 2




Цитата:
BohdanT, я к сожалению не знаю с какой стороны подойти к Эктив оберону.

В чем именно проблема?

Цитата:
Распарсить AOS'ные файлы не просто, т.к. содержат пользовательские коды UTF-8, хочу для начала переделать демку Qt'вую (TextEdit ), сделать там подсветку обероновскую.


Парсить AOS очень легко, если использовать Аосовские библиотеки Подмигивание
Вот Syntax Highlighter http://a2os.org.ua/forums/printf...mp;t=15&id=1

Цитата:
Работать в winAOS мне не нравится - неудобно. Я постаянно парюсь с отрытием/сохранением файлов - непривычно, что нужно набирать имя/путь, чтобы что-то сохранить под другим именем.

Т.е. не хватает менюшки с SaveAs ?


Цитата:
В принципе сейчас делать парсер ключей/команд необязательно, лично для меня - новичка - важно узнать какой модуль, что мне может предоставить, а так же посмотреть как связаны между собой модули.

Да.. это проблемка. По этому я и хочу, что бы была такая тулза. Но главное, что бы ее начали использовать в ETHZ. Тогда будет от нее толк.
Кстати я тут один эксперимент делал, но не закончил http://a2os.org.ua/forums/topic....90904#1224090904
Цитата:
По поводу документирования. Мне очень понравилась идея использовать коды UTF-8 из пользовательского пространства кодов вместо текста (doxygen) для создания тех или иных вещей (можно даже ссылки придумать).

Нужно подумать. Но я не уверен, что "хорошо" так делать (в смысле спец символы вставлять). Нужно глянуть как сделано в Черном Ящике.
Цитата:
PET - убожество его надо переделывать, но я не предствляю его архитектуру.

Ну в нем не все хорошо, видать сделано на скорую руку и долго не перерабатывалось. Тут еще есть огромное поле для деятельности. Но PET не проблема, проблема - WMTextView
 
 Top
lit-uriy Супермодератор
Отправлено: 12 Ноября, 2008 - 17:49:25
Post Id


Advanced Member


Покинул форум
Сообщений всего: 298
Дата рег-ции: Нояб. 2008  
Откуда: Тюмень / Новосибирск
Репутация: 0




BohdanT пишет:
Т.е. не хватает менюшки с SaveAs ?
Да, нужен диалог удобный для сохранения и для открытия файлов, как в виндовозе или КДЕ, но не Гномовское убожество.

BohdanT пишет:
В чем именно проблема?
Проблему опишу в другой теме

BohdanT пишет:
Парсить AOS очень легко, если использовать Аосовские библиотеки
Я имел в виду порпобывать в лбо - загнать в доксиген AOS'овские файлы

BohdanT пишет:
о я не уверен, что "хорошо" так делать (в смысле спец символы вставлять)
Я сторонник бинарного подхода, и ярый противник тестового (не навижу XML, в том числе за нечистоту правил)
 
 Top
BohdanT Администратор
Отправлено: 12 Ноября, 2008 - 18:43:27
Post Id



Super Member


Покинул форум
Сообщений всего: 606
Дата рег-ции: Июль 2008  
Откуда: Киев, Украина
Репутация: 2




lit-uriy пишет:
Да, нужен диалог удобный для сохранения и для открытия файлов, как в виндовозе или КДЕ,


Я поначалу даже его хотел сделать, но есть нюанс. Все дело в фаловой системе - она без каталогов. Растерялся
Однако, можно сделать "закладки фильтров" ну и вообще что то еще придумать.
Иногда утруждает отсутствие выборочной отметки.
lit-uriy пишет:
но не Гномовское убожество.
Покатываюсь со смеху


lit-uriy пишет:
Я имел в виду порпобывать в лбо - загнать в доксиген AOS'овские файлы

Это не решит проблему. Как я уже говорил, главное заставить ETHZ пользоваться утилитой. Т.е. если появится что то новое - оно сразу должно было задокументированно. А так в принципе не проблема написать по всему сществующему доку(в том числе подсунуть под доксиген, в начале файла хранится "авторская расскраска" которую просто можно скипать)... ну разве что все это сделать лень Хорошо , а некоторы считают ниже своего достоинства хелпы писать Ха-ха

lit-uriy пишет:
Я сторонник бинарного подхода, и ярый противник тестового (не навижу XML, в том числе за нечистоту правил)

Дело не в этом, а как оно будет в файле храниться и в WMTextView.TextView должны быть механизмы... трудно выразить мысль...
 
 Top
lit-uriy Супермодератор
Отправлено: 12 Ноября, 2008 - 18:49:32
Post Id


Advanced Member


Покинул форум
Сообщений всего: 298
Дата рег-ции: Нояб. 2008  
Откуда: Тюмень / Новосибирск
Репутация: 0




BohdanT пишет:
Я поначалу даже его хотел сделать, но есть нюанс. Все дело в фаловой системе - она без каталогов.
Однако файловый менеджер позволяет шастать по виндовозным дискам и каталогам, и открывать файлы.

BohdanT пишет:
Как я уже говорил, главное заставить ETHZ пользоваться утилитой.
Это мне не понятно.
Если будет инструмент который создает доки из исходников, то зависимости от ETH не будет, запустил - сгенерил. положил на сайт, люди, например я, могут скачать и помере надобности читать. все равно ни кто реально жить в AOS'е не будет - пока это иследовательско-академический проект, а не настольная система.
 
 Top
BohdanT Администратор
Отправлено: 12 Ноября, 2008 - 19:06:54
Post Id



Super Member


Покинул форум
Сообщений всего: 606
Дата рег-ции: Июль 2008  
Откуда: Киев, Украина
Репутация: 2




lit-uriy пишет:
Если будет инструмент который создает доки из исходников, то зависимости от ETH не будет, запустил - сгенерил. положил на сайт, люди, например я, могут скачать и помере надобности читать.

Ок. Ты пробовал компилить примеры из GUIPat.tar? Все работает?
Я это к чему, что то в ОС меняется (а в последнее время это частое явление, библиотека еще не устаканилась) и меняется везде, что приходится делать? Правильно: менять везде описания и т.д. Вот по этому я и хочу, что бы эту работу выполняли ЕТеаШовцы Улыбка

lit-uriy пишет:
все равно ни кто реально жить в AOS'е не будет - пока это иследовательско-академический проект, а не настольная система.

Я рассмотриваю Аос как ОС для встроенных систем. Настольной она скорее всего никогда не будет Ниндзя

lit-uriy пишет:
Однако файловый менеджер позволяет шастать по виндовозным дискам и каталогам, и открывать файлы.

Это да. Тут не поспоришь, в таком случае очень нужно. Но если честно, то лично я и так стартовал всяких проектов кучу, просто не осилю, если вдруг не ударит что то в голову или другое место.
 
 Top
Страниц (6): [1] 2 3 4 5 6 »
Сейчас эту тему просматривают: 1 (гостей: 1, зарегистрированных: 0, скрытых: 0)
« Творческие идеи и проекты »


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



Locations of visitors to this page
[Valid RSS]

RSS

Valid CSS!


Powered by ExBB
ExBB FM 1.0 RC1 by TvoyWeb.ru
InvisionExBB Style converted by Markus®

[Script Execution time: 0.0987]     [ Gzipped ]