diff --git a/docs/diagnostics/AssignAliasFieldsInQuery.md b/docs/diagnostics/AssignAliasFieldsInQuery.md index 680630d64df..0c7c5b1b37b 100644 --- a/docs/diagnostics/AssignAliasFieldsInQuery.md +++ b/docs/diagnostics/AssignAliasFieldsInQuery.md @@ -8,12 +8,14 @@ ## Описание диагностики -Рекомендуется указывать и необязательные конструкции запроса, прежде всего - явно назначать псевдонимы полям, в целях повышения наглядности текста запроса и "устойчивости" использующего его кода. Например, если в алгоритме используется запрос с полем, объявленным как +Рекомендуется указывать и необязательные конструкции запроса, прежде всего - явно назначать псевдонимы полям, в целях повышения наглядности текста запроса и "устойчивости" использующего его кода. +Например, если в алгоритме используется запрос с полем, объявленным как ```bsl Касса.Валюта ``` при изменении имени реквизита нужно будет также изменить и код, осуществляющий обращение по имени свойства Валюта к выборке из результата запроса. Если же поле будет объявлено как + ```bsl Касса.Валюта КАК Валюта ``` @@ -27,7 +29,8 @@ ## Примеры - ```bsl + +```bsl Запрос = Новый Запрос; Запрос.Текст = "ВЫБРАТЬ @@ -73,7 +76,8 @@ | Валюты.Ссылка // Неправильно | ИЗ | Справочник.Валюты КАК Валюты) КАК ВложенныйЗапрос"; // Игнорируется - ``` +``` + ## Источники Источник: [Оформление текстов запросов](https://its.1c.ru/db/v8std#content:437:hdoc) diff --git a/docs/diagnostics/CodeBlockBeforeSub.md b/docs/diagnostics/CodeBlockBeforeSub.md index 120ea616f4e..b359e966c6b 100644 --- a/docs/diagnostics/CodeBlockBeforeSub.md +++ b/docs/diagnostics/CodeBlockBeforeSub.md @@ -8,7 +8,8 @@ ## Описание диагностики -Структура программного модуля _(в общем виде)_ четко определена: +Структура программного модуля _(в общем виде)_ четко определена: + - сначала идет блок определения переменных - затем определения процедур и функции - затем блок кода модуля diff --git a/docs/diagnostics/CodeOutOfRegion.md b/docs/diagnostics/CodeOutOfRegion.md index fe7c60e9fcd..54330e90aa1 100644 --- a/docs/diagnostics/CodeOutOfRegion.md +++ b/docs/diagnostics/CodeOutOfRegion.md @@ -24,7 +24,7 @@ #Область <ИмяОбласти> ``` -Не смотря на то что в стандарте описано всего 10 имён, имена вложенных областей не проверяются. +Несмотря на то, что в стандарте описано всего 10 имён, имена вложенных областей не проверяются. Правильно: ```bsl @@ -39,6 +39,7 @@ ``` Таблица соответствия английских имён (полный список в [исходном коде](https://github.com/1c-syntax/bsl-language-server/blob/develop/src/main/java/com/github/_1c_syntax/bsl/languageserver/utils/Keywords.java#L255)): + | русск. | англ. | | ------------- | ------------- | | ПрограммныйИнтерфейс | Public | diff --git a/docs/diagnostics/CrazyMultilineString.md b/docs/diagnostics/CrazyMultilineString.md index 160690c1a34..d8469251db3 100644 --- a/docs/diagnostics/CrazyMultilineString.md +++ b/docs/diagnostics/CrazyMultilineString.md @@ -8,7 +8,8 @@ ## Описание диагностики -В исходном тексте многострочные константы могут задаваться двумя способами: +В исходном тексте многострочные константы могут задаваться двумя способами: + - 'классический', в котором используется символ переноса строки и конкатенация строк - 'странный', при котором строки разделяются пробельными символами diff --git a/docs/diagnostics/DeprecatedAttributes8312.md b/docs/diagnostics/DeprecatedAttributes8312.md index c809db1c4f1..e966be0c082 100644 --- a/docs/diagnostics/DeprecatedAttributes8312.md +++ b/docs/diagnostics/DeprecatedAttributes8312.md @@ -8,35 +8,32 @@ ## Описание диагностики В платформе 8.3.12 следующие элементы стали устаревшими: -* Для системного перечисления ГруппировкаПодчиненныхЭлементовФормы реализовано значение ГоризонтальнаяВсегда. -Значение системного перечисления ГруппировкаПодчиненныхЭлементовФормы.Горизонтальная считается устаревшим; -* Системное перечисление ОриентацияМетокДиаграммы более не доступно. Актуальный вариант ОриентацияПодписейДиаграммы; -* Свойства и методы объекта Диаграмма устарели и не рекомендуются к использованию: - * ПалитраЦветов; - * ЦветНачалаГрадиентнойПалитры; - * ЦветКонцаГрадиентнойПалитры; - * МаксимальноеКоличествоЦветовГрадиентнойПалитры; - * ПолучитьПалитру(); - * УстановитьПалитру(). -* Названия свойств объекта ОбластьПостроенияДиаграммы: - * ОтображатьШкалу; - * ЛинииШкалы; - * ЦветШкалы. -* Свойства объекта ОбластьПостроенияДиаграммы являются устаревшими, -не рекомендуются для использования и поддерживаются для совместимости: + +* Для системного перечисления `ГруппировкаПодчиненныхЭлементовФормы` реализовано значение `ГоризонтальнаяВсегда`, значение `ГруппировкаПодчиненныхЭлементовФормы.Горизонтальная` считается устаревшим +* Системное перечисление `ОриентацияМетокДиаграммы` более не доступно. Актуальный вариант `ОриентацияПодписейДиаграммы` +* Свойства и методы объекта Диаграмма устарели и не рекомендуются к использованию: + * `ПалитраЦветов`; + * `ЦветНачалаГрадиентнойПалитры`; + * `ЦветКонцаГрадиентнойПалитры`; + * `МаксимальноеКоличествоЦветовГрадиентнойПалитры`; + * `ПолучитьПалитру()`; + * `УстановитьПалитру()`. + +* Названия свойств объекта `ОбластьПостроенияДиаграммы`: + * `ОтображатьШкалу` + * `ЛинииШкалы` + * `ЦветШкалы` + +* Следующие свойства объекта `ОбластьПостроенияДиаграммы` являются устаревшими, не рекомендуются для использования и поддерживаются для совместимости: + * `ОтображатьПодписиШкалыСерии` - рекомендуется использовать `ШкалаСерий.ПоложениеПодписейШкалы` + * `ОтображатьПодписиШкалыТочек` - рекомендуется использовать `ШкалаТочек.ПоложениеПодписейШкалы` + * `ОтображатьПодписиШкалыЗначений` - рекомендуется использовать `ШкалаЗначений.ПоложениеПодписейШкалы` + * `ОтображатьЛинииЗначенийШкалы` - рекомендуется использовать `ШкалаЗначений.ОтображениеЛинийСетки` + * `ФорматШкалыЗначений` - рекомендуется использовать `ШкалаЗначений.ФорматПодписей` + * `ОриентацияМеток` - доступа рекомендуется использовать `ШкалаТочек.ОриентацияПодписей` - * ОтображатьПодписиШкалыСерии. Для доступа рекомендуется использовать ШкалаСерий.ПоложениеПодписейШкалы; - * ОтображатьПодписиШкалыТочек. Для доступа рекомендуется использовать ШкалаТочек.ПоложениеПодписейШкалы; - * ОтображатьПодписиШкалыЗначений. Для доступа рекомендуется использовать ШкалаЗначений.ПоложениеПодписейШкалы; - * ОтображатьЛинииЗначенийШкалы. Для доступа рекомендуется использовать ШкалаЗначений.ОтображениеЛинийСетки; - * ФорматШкалыЗначений. Для доступа рекомендуется использовать ШкалаЗначений.ФорматПодписей; - * ОриентацияМеток. Для доступа рекомендуется использовать ШкалаТочек.ОриентацияПодписей. -* Свойство ОтображатьЛегенду объектов Диаграмма, ДиаграммаГанта, СводнаяДиаграмма является устаревшим -и не рекомендуется для использования. -* Свойство ОтображатьЗаголовок объектов Диаграмма, ДиаграммаГанта, СводнаяДиаграмма является устаревшим и - не рекомендуется для использования. -* Метод глобального контекста ОчиститьЖурналРегистрации() -применим только к журналу в формата SQLite, признан устаревшим и его использование не рекомендуется. +* Свойства `ОтображатьЛегенду` и `ОтображатьЗаголовок` объектов `Диаграмма`, `ДиаграммаГанта`, `СводнаяДиаграмма` являются устаревшими и не рекомендуются для использования +* Метод глобального контекста `ОчиститьЖурналРегистрации()` применим только к журналу в формате `SQLite`, признан устаревшим и его использование не рекомендуется ## Источники diff --git a/docs/diagnostics/DeprecatedMethods8317.md b/docs/diagnostics/DeprecatedMethods8317.md index 129fc8392ec..d06acaa4c4a 100644 --- a/docs/diagnostics/DeprecatedMethods8317.md +++ b/docs/diagnostics/DeprecatedMethods8317.md @@ -7,14 +7,17 @@ ## Описание диагностики -В платформе 8.3.17 было реализовано свойство глобального контекста ОбработкаОшибок и -стандартная функция Управление настройками обработки ошибок, позволяющая настроить тексты ошибок. -Методы глобального контекста: -* КраткоеПредставлениеОшибки(); -* ПодробноеПредставлениеОшибки(); -* ПоказатьИнформациюОбОшибке() считаются устаревшими. - -Необходимо использовать одноименные методы объекта ОбработкаОшибок. +В платформе `8.3.17` было реализовано свойство глобального контекста `ОбработкаОшибок` и +стандартная функция `Управление настройками обработки ошибок`, позволяющая настроить тексты ошибок. + +Методы глобального контекста считаются устаревшими: + +* `КраткоеПредставлениеОшибки()` +* `ПодробноеПредставлениеОшибки()` +* `ПоказатьИнформациюОбОшибке()` + +Необходимо использовать одноименные методы объекта `ОбработкаОшибок`. + ## Источники diff --git a/docs/diagnostics/JoinWithSubQuery.md b/docs/diagnostics/JoinWithSubQuery.md index fa616b28fb1..bd671772a1a 100644 --- a/docs/diagnostics/JoinWithSubQuery.md +++ b/docs/diagnostics/JoinWithSubQuery.md @@ -11,10 +11,11 @@ При написании запросов не следует использовать соединения с вложенными запросами. Следует соединять друг с другом только объекты метаданных или временные таблицы. Если запрос содержит соединения с вложенными запросами, то это может привести к следующим негативным последствиям: + - Крайне медленное выполнение запроса при слабой загрузке серверного оборудования - Нестабильная работа запроса. При некоторых условиях запрос может работать достаточно быстро, при других - очень медленно -- Значительная разница по времени выполнения запроса на разных СУБД; -- Повышенная чувствительность запроса к актуальности и полноте статистик. Сразу после полного обновления статистик запрос может работать быстро, но через некоторое время опять замедлиться. +- Значительная разница по времени выполнения запроса на разных СУБД +- Повышенная чувствительность запроса к актуальности и полноте статистик. Сразу после полного обновления статистик запрос может работать быстро, но через некоторое время опять замедлиться ## Примеры diff --git a/docs/diagnostics/SelectTopWithoutOrderBy.md b/docs/diagnostics/SelectTopWithoutOrderBy.md index 7a5c91afa7f..da00ca77f6a 100644 --- a/docs/diagnostics/SelectTopWithoutOrderBy.md +++ b/docs/diagnostics/SelectTopWithoutOrderBy.md @@ -15,10 +15,12 @@ Использование конструкции `ПЕРВЫЕ N` без указания порядка сортировки в `УПОРЯДОЧИТЬ ПО` или условий в секции `ГДЕ` чревато получением неожиданных результатов: + - В разных СУБД порядок возвращаемых результатов может отличаться - Порядок в разных копиях ИБ будет отличаться от порядка, который ожидает разработчик По стандарту, отсутствие предложения `УПОРЯДОЧИТЬ ПО` оправдано только в тех случаях, когда + - алгоритм обработки результатов запроса не рассчитывает на определенный порядок записей - результат обработки выполненного запроса не показывается пользователю - результат запроса - заведомо одна запись @@ -27,7 +29,8 @@ ### Алгоритм работы диагностики -В процессе анализа считаются ошибочными конструкции +В процессе анализа считаются ошибочными конструкции: + - Использование `ПЕРВЫЕ N` в объединении вне зависимости от наличия `УПОРЯДОЧИТЬ ПО`, т.к. упорядочивание происходит уже после объединения - Использование `ПЕРВЫЕ N`, где `N > 1` при отсутствии `УПОРЯДОЧИТЬ ПО` - Использование `ПЕРВЫЕ 1`, при отсутствии `УПОРЯДОЧИТЬ ПО` и условий в `ГДЕ`. Данное правило по умолчанию отключено параметром диагностики diff --git a/docs/diagnostics/StyleElementConstructors.md b/docs/diagnostics/StyleElementConstructors.md index b337c64681b..5d485787fb8 100644 --- a/docs/diagnostics/StyleElementConstructors.md +++ b/docs/diagnostics/StyleElementConstructors.md @@ -9,9 +9,10 @@ Для изменения оформления следует использовать элементы стиля, а не задавать конкретные значения непосредственно в элементах управления. Это требуется для того, чтобы аналогичные элементы управления выглядели одинаково во всех формах, где они встречаются. Виды элементов стиля: -* Цвет (задается значение RGB) -* Шрифт (задаются вид, размер и начертание) -* Рамка (задаются тип и ширина границ) + +* `Цвет` - задается значение RGB +* `Шрифт` - задаются вид, размер и начертание +* `Рамка` - задаются тип и ширина границ ## Примеры diff --git a/docs/diagnostics/UsingObjectNotAvailableUnix.md b/docs/diagnostics/UsingObjectNotAvailableUnix.md index f90906ac64d..91064e60709 100644 --- a/docs/diagnostics/UsingObjectNotAvailableUnix.md +++ b/docs/diagnostics/UsingObjectNotAvailableUnix.md @@ -7,20 +7,20 @@ ## Описание диагностики -В ОС Linux недоступны механизмы COM, OLE, ActiveDocument. Для интеграции -необходимо использовать другие средства, например файловый обмен в формате XML или web-сервисы. -Для внешних компонент, реализованных по COM-технологии, рекомендуется переработать их с использованием технологии NativeAPI. +В ОС `Linux` недоступны механизмы `COM`, `OLE`, `ActiveDocument`. Для интеграции необходимо использовать другие средства, например файловый обмен в формате XML или web-сервисы. +Внешние компоненты, реализованные по COM-технологии, рекомендуется переработать с использованием технологии `NativeAPI`. Отслеживаемые механизмы, недоступные в Linux: -* COMОбъект -* Почта +* `COMОбъект` +* `Почта` -**Проверка значение выполнения условия пока не выполняется.** +**Проверка значения выполнения условия пока не выполняется.** ### Дополнительно При проверке использования недоступных объектов в Linux учитываются условия, в которых можно найти следующий ключевые слова: + * `Linux_x86` * `Windows` * `MacOs`