== Принципы написания кода ==
# '''"Правило бойскаута" - Оставь место стоянки чище, чем оно было до твоего прихода.'''
#: Если мы все будем оставлять свой код чище, чем он был до нашего прихода, то код попросту не будет загнивать. Чистка не обязана быть глобальной. Присвойте более понятное имя переменной, разбейте слишком большую функцию, устраните одно незначительное повторение, упростите сложную цепочку условий.
# '''Названия классов, методов, функций, переменных должны быть говорящими и не вводящими в заблуждение'''
# '''JAVA-doc должен быть актуальным. Поменял функцию - обнови описание'''
# '''JAVA-doc должен описывать каждый класс и метод'''
# '''Разбиение сложного на простое'''
## ''Сложные условия лучше выносить в методы или переменные с говорящими названиями''
## ''Длинные методы лучше разбивать на более мелкие. Метод в 50 строк - слишком большой''
## ''Методы, содержащие более 7 параметров лучше разбивать на несколько более мелких''
# '''Максимальное использование имеющегося функционала. Избегать дублирования.'''
#: Перед тем как приступить к созданию класса-утилиты с функцией, которая вам пригодится при реализации задачи, подумайте, может такая функция уже где то есть?
# '''Параметризовывать потенциально изменяемые данные или использовать шаблонизацию'''
# '''Общие части классов выносить в класс-родитель (если его нет то создать и унаследоваться от него, сохраняя при этом согласованную абстракцию - классы должны использоваться в рамках одной области например - "платежные поручения" или "документы клиентов")'''
# '''Реализовывать логику там, где это уместно.'''
## ''Логика отрисовки html должна быть в gsp, всё остальное в контроллер(наилучший вариант - в сервис)''
## ''Логика работы с моделями - в моделях''
## ''Вспомогательные функции - в утилиты(только если нет похожего функционала)''
# '''Обязательно вести логирование на всех уровнях'''
## ''DEBUG - информация, полезная разработчику для отладки''
##: Если это будет сделано на этапе разработки, нам не придётся делать это в рамках задач-ошибок с приоритетом критикал посредством патчей.
## ''INFO - информация, полезная сотруднику банка''
##: Система будет более прозрачна для понимания. Сотрудник банка сможет отследить операции, действия совершаемые клиентом, при необходимости.
## ''WARN - информация об ошибках, не критичных для работы системы''
##: При установке версии забыли прописать параметр? - не нужно при этом молча отключать функционал. Предупреждайте, например так: "В системе не прописан путь к настройкам кредитного калькулятора. Кредитный калькулятор будет работать в режиме без привязки к кредитным продуктам банка."
## ''ERROR - информация о критичных ошибках''

== Анализ примеров и правило бойскаута в действии ==

=== Понятное название ===
И без комментария ясно что мы получим тарифный план
<code>
 def getTariffPlan () {
     ....
 }
</code>

=== Название, которое вводит в заблуждение ===

<code>
 function checkPayeeAccountForBudget() {
        var budgetAccounts = ["401", "402", "403", "404"];
        if ($("#payee-account").val()){
            if ($.inArray($("#payee-account").val().substring(0, 3), budgetAccounts) > -1) {
                $('#calc-nds-kind').attr("value", '3'); //автоподстановка значения без запрета на изменение
                $('#calc-nds-kind').change();
            }
        }
    }
</code>
Как мы видим из тела функции, помимо проверки приндлежит ли счёт бюджету, функция еще выполняет подстановку НДС.

Теперь приведём код в красивый и понятный вид <br/>
<pre>
function checkPayeeAccountForBudget(account) {

    var budgetAccounts = ["401", "402", "403", "404"],
        conto = account.substring(0, 3);

    return $.inArray(conto, budgetAccounts) > -1;
}

function processChangeAccount() {

    var account = $.trim($("#payee-account").val());

    if (account != '') {
        if (checkPayeeAccountForBudget(account)) {
            $('#calc-nds-kind').val('3').change();
        }
    }
}
</pre>
Мы разбили функцию на две, и каждая функция делает только одну функцию и это хорошо. Код стал понятным. Заодно мы и изменили некорректную проверку на заполненность поля "#payee-account", расставили отступы, убрали комментарий капитана очевидность:
<pre>
$('#calc-nds-kind').attr("value", '3'); //автоподстановка значения без запрета на изменение
</pre>
и убрали дублирование взятия объекта, воспользовавшись мощью jquery:
<pre>
$('#calc-nds-kind').val('3').change();
</pre>

=== Использование JAVA-doc ===
'''Результатом работы метода должно быть ВСЕГДА значение одного типа'''
<p>
Метод не должен возвращать или объект, или ассоциативный массив или null.
</p>

<pre>
/**
 * Общая часть запроса для запросов Системы "Город"
 * @param params запрашиваемые параметры
 * @return строка
 */
 private _getGeneralPart(params) { ... }
</pre>
Замечательно правда? Нам не нужно анализировать тело функции, чтобы понять, что она делает.