Рекомендации к написанию кода

В данной статье описаны рекомендации для прикладных разработчиков, разрабатывающих компоненты на базе «Форсайт. Аналитическая платформа».

Список статей:

  1. Наследование компонентов.

  2. Принципы кодирования.

  3. Рекомендации к CSS коду.

  4. Сценарии использования компонентов.

Общие требования

Кроме описанных в статьях особенностей, существует ряд общих требований к разработке:

  1. Главная библиотека PP.js и PP.css должна подключатся выше остальных дополнительных библиотек платформы.

  2. Компонент создается при создании экземпляра класса с помощью new. Создание компонента выполняется созданием экземпляра класса с помощью new.

  3. Допускается использование только публичных методов и свойств. Приватные методы могут поменять свое названием или быть удалены.

Соглашения об именованиях

Имена классов, перечислений, членов перечислений, полей должны придерживаться UpperCamelCase правила. Имена локальных переменных, методов должны придерживаться правила lowerCamelCase. Имена свойств в параметрах событий должны придерживаться UpperCamelCase.

Структура html-страницы

Для создания примеров с использованием DHTML-компонентов соблюдайте структуру html-страницы.

В теге <html> задается два тега:

<link href="<относительный путь css-файла>" rel="stylesheet" type="text/css"/>

<script src="<относительный путь js-файла>" type="text/javascript"/></script>

<style type="text/css">

    <параметры стиля контейнера>

</style>

Примечание. Тег с параметрами стиля необязательный.

<script text="text/javascript">

    function <наименование функции>() {

        <сценарий использования DHTML-компонента>

    }

</script>

    <div id="<идентификатор компонента>"></div>

</body>

См. также:

Веб-приложение