Ключевое правило
- В XML-доке: маркеры в конце строки без второго
//(пример:// … ✦). - В BSL-коде: маркеры всегда внутри хвостового комментария (пример:
… //⚙). - Везде перед маркером — 3 пробела.
Таблица
| Иконка | Назначение |
|---|---|
| ✦ | <summary> в XML-доке |
| ➤ | <param> в XML-доке |
| ⬅ | <returns> в XML-доке |
| ⚙ | Function/Procedure (только код, как //⚙) |
| ⚡ | If/ElseIf/Else (код, //⚡) |
| ⟳ | For/While/For Each (код, //⟳) |
| ✏ | Присваивание (код, //✏) |
| ✱ | Try (код, //✱) |
| ↩ | Return (код, //↩) |
| ✖ | Break (код, //✖) |
| ▶️ | Вызов A1s-функции (код, //▶️) |
| ✍ | строка ib (код, //✍) |
Примеры
XML-док
XML-докнаведите на цветной токен, чтобы увидеть его рольSTANDARD
// <doc>
// <summary>Чтение файла</summary> ✦
// <param i="1" name="Path" type="String">Путь к файлу</param> ➤
// <returns>String — содержимое или Неопределено</returns> ⬅
// </doc>Код
Коднаведите на цветной токен, чтобы увидеть его рольSTANDARD
Функция ReadText(Path, Encoding="UTF-8") Экспорт //⚙
ib = "Чтение текстового файла"; //✍
Попытка //✱
Если НЕ ЗначениеЗаполнено(Path) Тогда //⚡
Возврат Неопределено; //↩
КонецЕсли;
Исключение
A1sLog.Error(ib, ОписаниеОшибки()); //▶️
Возврат Неопределено; //↩
КонецПопытки;
Возврат "OK"; //↩
КонецФункции