ABillS постоянно меняется, и потому переменные системы удаляются, добавляются новые или меняются существующие.
А особенно, совсем недавно появилась функция парсинга описаний переменных с документации, то ещё более актуально.
Правила:
- Описание переменной должно быть лаконичным
- Документация с упоминанием переменной должно ссылаться на страницу описания
- Если описание переменной потребует большого количества текста и множества илюстраций, то выводить полное описание в отдельную страницу, и в кратком описании ссылаться на вышеописанную статью
- Обязательно, в ячейке таблицы названия переменной оставлять heading таблицы
Насчёт пункта 4, наглядно пример:
| NORMAL_CONFIG_PARAM | Лаконичное описание переменной |
|---|
Чтобы сделать такое "оглавление", нужно нажать на кнопку:
Также не забыть добавить новую переменную в config_variables.sql через модуль Config