Обработка комментариев компилятором
Добавлено: 08.01.21 19:27
На основании этого текста предлагаю обсудить такую мысль:КротОзёр писал(а): ↑08.01.21 18:42Кстати, а, ведь, идея встроить в комментарии нативную поддержку форматирования — замечательная мысль!БудДен писал(а): ↑08.01.21 13:37Т.е. лучшего места для хранения документации, чем исходник, я не могу себе представить. Вовне я бы выносил только какие-то общие статьи. Да и на тот случай в G2 есть макрос defconcept, к-рый позволяет прямо в исходники вставлять эти общие статьи. С форматами, от маркдауна до ТеХа и со средами разработки, вполне можно сделать работу с такими комментариями комфортной.
Можно представить отображение исходников средой разработки примерно таким же образом, как и у текстового процессора.
Правда тогда возникнет неразрывная зависимость языка от среды разработки (как у Object Pascal с Delphi).
- В синтаксис языка программирования вводится раздел форматирования комментариев. Аналог того же MarkDown-а;
- Согласно стандарту предписывается анализ внутреннего форматирования комментариев;
- Вносится дополнительный формат файлов исходных кодов *.man или ему подобные;
- Объявление функции, структуры или иной функциональной составляющей кода в файле руководства автоматически связывает описание с таковым в исходном коде;
- В среде разработки при выборе опции "подробно" к комментарию и наличии описания в тексте руководства, автоматически открывается описание;
- В той же среде разработки при выделении имени сущности и нажатии F1 открывается описание;
- Допускаются гипертекстовые переходы и отсылки между другими описаниями, вставки текста из шаблонов;
- Обязательно применение международных кодировок вроде UTF-8;
- Среда разработки допускает два формата работы с комментариями: 1) WYSYWIG; 2) PlainText. По-русски это звучит так: 1) Как вижу; 2) Только текст.