ДОКУМЕНТИРОВАНИЕ ФУНКЦИЙ/ОПЕРАЦИЙ

Документирование функций/операций

При работе с операцией или функцией в СПК действует специальный формат для документирования кода (JSDoc). С его помощью можно добавить комментарии, которые помогут опеределить значение функции/операции, а также используемые при написании аргументы и параметры.

Операция

При создании или редактировании операции можно указать:

  • описание операции;
  • @author —  в строке укажите ФИО автора операции;
  • @editor — введите ФИО сотрудника, который редактирует операцию.

Функция

При создании или редактировании функции можно указать:

  • описание функции;
  • @param — принимаемые аргументы;
  • @return — возвращаемые параметры;
  • @author — в строке укажите ФИО автора операции;
  • @editor — ФИО сотрудника, который редактирует операцию;
  • код функции и дополнительные комментарии.

Ошибки при документировании функций/операций

В сервисе прикладного кода важно соблюдать формат документирования. Для создаваемых функций/операций отсутствие комментариев является ошибкой. В случае их редактирования будет выведено предупреждение.

  • «Необходимо документировать функцию/операцию комментариями в формате JSDoc» — отсутствие блока комментария;
  • «Необходимо описание функции/операции» — если перед тегами в комментарии не будут найдены корректные символы;
  • «Аргумент не документирован» — если для одного из параметров не будет найден тег @param с корректным указанием типа и имени аргумента;
  • «Аргумент не указан в объявлении функции» — имя аргумента в одном из тегов @param не совпадает с именем аргумента принимаемого функцией;
  • «Дублирующееся описание параметра» — дублирование описания для аргумента (имена у аргументов должны быть разные);
  • «Необходим тег @return с описанием типа возвращаемого функцией значения» — отсутствует тег @ return с описанием типа возвращаемого функцией значения;
  • «Функция должна быть объявлена» — если в коде отсутствует элемент, который объявляет функцию;
  • «Объявление функции должно быть единственным блоком» — в коде должен быть только один элемент, который объявляет функцию;
  • «Функция должна быть объявлена с тем же именем»— имя функции в объявлении отличается от имени указанного в заголовке редактора.
0
0
Оставьте свой отзыв:
ОТПРАВИТЬ