- Отделяйте функцию какой либо строчкой одинаковых символов, это позволяет существенноо быстрее взглядом находить нужные функции. Даже если ваш редактор позволяет находить необходимую функцию по клику, это все равно желательно делать, потому что ситуации могут быть разными, например завтра у вас под рукой может не оказатсья любимово редактора, а исправление нужно сделать срочно или кто-то после вас будет редактировать код, то постарайтесь облегчить ему работу. Уверяю вам будет почет и уважение.
- На против каждой функции пишите кратко какой результат возвращает функция или что она делаеть, но только в кратце. Не нужно расписывать на 25 страниц что все делается
- Настоятельно рекомендуется описывать входящие параметры. Не называть входящий параметр в размере одной буквы даже если функция у вас в одну строчку.
- Также рекомендуется к входящим параметрам добавлять абриавиатуру «_» это существенно увеличивает читабельность функции, то есть сразу понятно, где работаете с входящим параметром, а где с локальными переменными функции.
- В начале каждой функции ставте свою абривиатуру в 2-3 буквы это позволит выделять ваши функции, существенно облегчит читабельноть, поиск, а также позволит избежать накладок с другими фреймворками.
// _____________________________________________________________________________
function name_function(_date,_format)
// Выполняет: Date To String - возвращает дату в заданном формате
// _date - дата в UNIX формате (целое число) или в формате TIMESTAMP
// _format - требуемый формат вывода
{
var s='';
return s;
}