Forth и другие саморасширяющиеся системы программирования Locations of visitors to this page
Текущее время: Сб апр 20, 2024 05:50

...
Google Search
Forth-FAQ Spy Grafic

Часовой пояс: UTC + 3 часа [ Летнее время ]




Начать новую тему Ответить на тему  [ Сообщений: 13 ] 
Автор Сообщение
 Заголовок сообщения: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 14:18 
Никто часом не думал о системе самодокументации кода программы? Т.е. иметь так построенный комментарии, что-бы потом из них можно было автоматом вытаскивать Help...


Вернуться к началу
  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 14:51 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
Сразу представилось...
Код:
: LPT-OUT ( мануал по управляющим кодам принтера ) ;
: INTERPRET ( КРАТКОЕ ВВЕДЕНИЕ В фОРТ ) ;
: FFT ( ОБЩАЯ ТЕОРИЯ ПРЕОБРАЗОВАНИЯ фУРЬЕ ) ;

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 15:19 
Не все так просто. Не все комментарии надо заносить в Help и не обязательно только слова объявленные через : .

Т.е. в комментарии надо как-то указать что потом будет полезно, а что "для внутреннего использования".
По мотивам существующего fhlp
Код:
CODE RSHIFT ( x1 u -- x2 ) \ 94
( *** RSHIFT { x1 u -- x2  }
Сдвинуть x1 на u бит вправо. Поместить нули в наиболее значимые биты, освобождаемые при сдвиге.
Неоднозначная ситуация возникает, если u больше или равно числу бит в ячейке. )
     MOV ECX, EAX
     MOV EAX, [EBP]
     SHR EAX, CL
     LEA EBP, 4 [EBP]     
     RET
END-CODE


Вернуться к началу
  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 15:22 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
Вообще, возникает впечатление, что такой хелп должен быть разновидностью навигатора по исходному коду

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 15:49 
Не в сети
Moderator
Moderator
Аватара пользователя

Зарегистрирован: Ср дек 06, 2006 09:23
Сообщения: 660
Благодарил (а): 7 раз.
Поблагодарили: 25 раз.
вроде бы MPE такое практикует


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 15:52 
До навигатора не дотягивает - тот должен вытаскивать информацию из не подготовленного исходника.
Пока только смотрю в сторону аналога Генератора документации существующего для других языков.


Вернуться к началу
  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 15:53 
diver писал(а):
вроде бы MPE такое практикует

Что или кто такое MPE ?


Вернуться к началу
  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 16:02 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
ArtemKAD писал(а):
До навигатора не дотягивает - тот должен вытаскивать информацию из не подготовленного исходника.

a это уже нереальное требование. В "неподготовленном исходнике" может не быть инфы для хелпа

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 16:18 
Не в сети
Moderator
Moderator
Аватара пользователя

Зарегистрирован: Ср дек 06, 2006 09:23
Сообщения: 660
Благодарил (а): 7 раз.
Поблагодарили: 25 раз.
ArtemKAD писал(а):
diver писал(а):
вроде бы MPE такое практикует

Что или кто такое MPE ?

MicroProcessor Engineering - http://www.mpeforth.com/


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 16:33 
Цитата:
a это уже нереальное требование. В "неподготовленном исходнике" может не быть инфы для хелпа

Doxygen это по Сишным и не только исходникам делает. Вытаскивает функции, объекты, переменные, структуры и если есть - оформленные комментарии. Потом создает доку с гиперссылками по которым можно понять смысл исходника.


Вернуться к началу
  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 16:53 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
ArtemKAD писал(а):
Потом создает доку с гиперссылками по которым можно понять смысл исходника.

Вот это я и называю:
WingLion писал(а):
разновидностью навигатора по исходному коду

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 19:42 
Не в сети
Аватара пользователя

Зарегистрирован: Вт мар 20, 2007 23:39
Сообщения: 1261
Благодарил (а): 3 раз.
Поблагодарили: 19 раз.
Если придерживаться определенного стиля комментирования, то все описания и комментарии легко извлекаются парой регэкспов.

_________________
Cтоимость сопровождения программного обеспечения пропорциональна квадрату творческих способностей программиста.
Роберт Д. Блисc


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
 Заголовок сообщения: Re: Самодокументация...
СообщениеДобавлено: Чт янв 03, 2013 19:58 
Не в сети
Administrator
Administrator
Аватара пользователя

Зарегистрирован: Вт май 02, 2006 13:19
Сообщения: 3565
Откуда: St.Petersburg
Благодарил (а): 4 раз.
Поблагодарили: 72 раз.
они так же легко извлекаются переопределением слов-коментариев - ( \ // -- и т.п. и модификацией определяющих слов так, чтобы комментарии привязывались к соответствующим словам

_________________
С уважением, WingLion
Forth-CPU . RuF09WE
Мой Форт
Отсутствие бана это не заслуга юзера, а недоработка модератора (с)


Вернуться к началу
 Профиль Отправить личное сообщение  
Ответить с цитатой  
Показать сообщения за:  Поле сортировки  
Начать новую тему Ответить на тему  [ Сообщений: 13 ] 

Часовой пояс: UTC + 3 часа [ Летнее время ]


Кто сейчас на конференции

Сейчас этот форум просматривают: нет зарегистрированных пользователей и гости: 55


Вы не можете начинать темы
Вы можете отвечать на сообщения
Вы не можете редактировать свои сообщения
Вы не можете удалять свои сообщения
Вы не можете добавлять вложения

cron
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group
phpBB сборка от FladeX // Русская поддержка phpBB