Что добавить в описание языка?

[Utkin]

В общем имеется некий язык программирования, вернее не так. Имеется множество диалектов языка программирования, отличия которых заключается в синтаксисе и еще в кое-каких мелочах. Мне лень отслеживать все те новвоведения, которые я в него запихиваю и я замутил программку автоматически генерирующую описание указанного диалекта. В общем и целом проект удался. Но мне нужно уточнить, что нужно добавить еще в описание (прикрепил ниже).

[DeKot]

Формат rtf явно не лучший выбор для статьи. У меня в OpenOffice читаемость ужасная, да еще с крякозюбрями.

[Utkin]

Ну это понятно, могу включить возможность сохранения в txt, для RichEdit'а это не проблема.

ЗЫ. RichEdit иногда создает артефакты - он перепутывает части строк между собой (полслова оттуда, полслова отсюда). Объяснение этому феномену не нашел.

[Neeter]

Да, дали уж почитать документик.
Может быть не хватает оглавления?

Теперь серьезно.
Чего-то не хватает, читать не интересно. И вполне не познавательно, особенно для начинающего, думаете, будет интересно ничего не понимающему человеку читать:

Условие
Внутренний идентифкатор конструкции: 9
Конструкция состоит из следующих элементов:
<элемент1><параметр1><элемент2><пар аметр2>, где:
<элемент1> ::= | ЕСЛИ |
<параметр1> - доступный идентификатор входящего параметра
<элемент2> ::= | ТО | ТОГДА |
<параметр2> - доступный идентификатор входящего параметра

Как-то по другому надо это описать.

Еще интересно, где вообще это описание будет находится?

А так, вроде всего хватает, уж не знаю, что можно еще написать.

[DeKot]

Для любого серъезного текста (официального) желательно применять распространенные шрифты (Таймс, Ариал и т.п).
По смыслу - согласен полностью с Neeter, скучно. До конца так и не прочитал.

[Utkin]

Сообщение от Neeter

Да, дали уж почитать документик.
Может быть не хватает оглавления?

Да я то причем? Это все прога генерит. Берется шапка-шаблоно, в нее впихивается описание конструкций и функций.

Теперь серьезно.
Чего-то не хватает, читать не интересно. И вполне не познавательно, особенно для начинающего, думаете, будет интересно ничего не понимающему человеку читать:

Думаю нет , это не для начинающего, а для всяких академиков. Любой уважающий себя язык программирования имеет такое извращение, да еще в форме БНФ (мое описание не совсем ему соответствует).
Для начинающих будт подготовлен учебник по данному языку и по программированию в общем.

Как-то по другому надо это описать.

Например?

Еще интересно, где вообще это описание будет находится?

Это интерпретатор, совмещенный с такой фигней по типу flex или бизона . Программист должен знать концепции, синтаксис он может задавать произвольно в некоторых рамках. Я могу вместо фрагментов использовать сишные фигурные скобки или паскалевские блоки begin-end. Более того, я могу переводить с одного диалекта на другой, в случае если они эквивалентны между собой. Имея такое описание другой программер может разобраться чем почем . Он будет иметь внутреннее описание диалекта - запустит прогу и получит такое вот описание.

А так, вроде всего хватает, уж не знаю, что можно еще написать.

Может не хватает каких-то ключевых моментов? Ну там чего-нибудь в структуре программы или еще что?

Для любого серъезного текста (официального) желательно применять распространенные шрифты (Таймс, Ариал и т.п).

Согласен исправлю, просто шаблон в 2007 офисе делал, а у него бзик на всякую муть...

[Neeter]

Например?

Покрасивей генерить что ли, таблицей например. Но, если этот документ только академики читать будут, то им хватит и такого описания.

Может не хватает каких-то ключевых моментов? Ну там чего-нибудь в структуре программы или еще что?

Пока придумать не могу. Только оформление страдает, а так, информации достаточно.

[Utkin]

Сообщение от Neeter

Покрасивей генерить что ли, таблицей например. Но, если этот документ только академики читать будут, то им хватит и такого описания.

Пока придумать не могу. Только оформление страдает, а так, информации достаточно.

Поменял шрифт, а для академиков - чем хуже тем лучше (наверно они все из Челябинска ).

[JTG]

Серьёзно Во-первых разбить на разделы с номерами, во-вторых использовать, где возможно, man-подобную разметку с отступами типа

Поля lua_Debug имеют следующее значение:
source

Если функция была определена в строке, source как раз и будет этой строкой, а если функция была определена в файле, source начинается с @, а дальше имя файла.

short_src

Пригодная к печати версия source, чтобы использоваться в сообщениях об ошибке.

linedefined

Код строки, где было начато определение функции.

what

Строка "Lua", если это функция Lua, "C", если это функция C или "main", если это основная часть chunk.

currentline

Текущая строка, где данная функция выполняется. Когда никакая информация о строке недоступна, currentline установлен в -1.