Имя переменной должно максимально четко соответствовать хранимым в ней данным. Переменные из нескольких слов пишутся в «camelCase»
Примеры:
var price;
const link;
let borderLeftWidth;
isCat = false; // переменные булевого типа
hasScales = true; // переменные булевого типа
Имя функции следует тем же правилам, что и имя переменной. Основное отличие – оно должно быть глаголом
Как правило, используются глагольные префиксы, обозначающие общий характер действия, после которых следует уточнение.
Примеры:
showMessage(..) // префикс show, "показать" сообщение
checkPermission(..) // check, "проверяет" разрешение, возвращает true/false
getIsAjax(..) // возвращает true/false
Хорошей практикой является - одна функция – одно действие. В функции не должно быть ничего, кроме самого действия и поддействий, неразрывно связанных с ним.
Например, функция проверки данных (скажем, "validate") не должна показывать сообщение об ошибке. Её действие – проверить и вернуть результат валидации.
- Функции
/**
* Takes 2 numbers and returns their sum.
*
* @param {number} a the first number
* @param {number} b the second number
* @param {number} [c=0] the optional third number
*
* @returns {number} the sum of a and b
*/
function addNumbers(a, b, c) {
if (typeof c === "undefined") {
c = 0;
}
return a + b + c;
}
- Переменные
/**
* The current environment we're running in.
*
* @type {string}
*/
var currentEnvironment = getEnvironment();
- Модули
/**
* description of module here
*
* @module ModuleName
*/
module.exports = new(function () {
...
Для проверки равенства используйте строгое равенство ===
Не забывайте удалять console.log
Источники:
https://learn.javascript.ru/variable-names
https://learn.javascript.ru/function-basics#function-naming
https://github.com/shri/JSDoc-Style-Guide
http://usejsdoc.org/