Рекомендации по именованию переменных и методов

92430

1. Используйте достаточно короткие и длинные имена переменных в каждой области видимости кода. В большинстве случаев, длина составляет 1 символ для счетчиков в цикле, 1 слово для условия или переменной цикла, 1-2 слова для методов, 2-3 слова для классов, 3-4 слова для глобальных переменных.

2. Используйте специфические имена для переменных. Например, имена «value», «equals», «data» не являются валидными именами где бы их не использовали.

3. Используйте смысловые имена для переменных. Имя переменной должно передавать точный смысл её содержимого.

4. Не используйте префиксы для переменной такие как o_, obj_, m_ и так далее для. Для переменной не нужно указывать дополнительную пометку, что она переменная.

5. Соблюдайте стандарты компании по именованию переменных в коде вашего приложении. Пример стандарта: txtUserName, lblUserName, cmbSchoolType. В противном случае, читаемость кода уменьшится, а также функции поиска замены в редакторе станут непригодными.

6. Соблюдайте стандарты вашего языка программирования и не используйте нижний/верхний регистр непоследовательно, то есть userName, UserName, m_userName, username, …

Пример для языка Java:

a. Используйте т.н. верблюжий стиль (camel style) для классов: VelocityResponseWriter

b. Используйте нижний регистр для имен пакетов:  com.company.project.ui

c. Используйте смешанный регистр для переменных: studentName

d. Используйте верхний регистр для констант: MAX_PARAMETER_COUNT = 100

e. Используйте верблюжий стиль для имен перечислений enum и верхний регистр для значений перечисления

f. Не используйте «_» вообще, если это только не константы и значения enum (которые являются константами)

7. Не используйте то же самое имя переменной в том же самом классе, но в различных контекстах, то есть в методах, конструкторах, классах. На самом деле вы можете дать более простое имя для понимания и читаемости.

8. Не используйте тоже самое имя переменной для различных целей в методе, условии и так далее. Вмесето этого создавайте новую переменную, с новым именем. Это также важно для поддержки кода и его читаемости.

9. Не используйте  не ASCII символы в именах переменных. Это может работать на вашем окружении/платформе, но не будет работать на остальных.

10. Не используйте слишком длинные имена переменных (например 50 символов). Длинные имена сделают код уродливым и тяжело читаемым, а также могут не работать на некоторых компиляторах из-за ограничения количества символов.

11. Используйте один натуральный язык для именования. Использование смеси английского и немецкого для именования, приведет к несогласованности и плохой читаемости кода.

12. Используйте смысловые имена методов. Имя метода должно определять точное действие метода и для большинства случаев должно начинаться с глагола (например createPasswordHash).

13. Соблюдайте стандарты компании по именованию и пишите их имена согласованно в коде приложения, например: getTxtUserName(), getLblUserName(), isStudentApproved(). В противном случае, читаемость кода уменьшится, а также функции поиска и замены в редакторе станут непригодными.

14. Соблюдайте стандарты вашего языка программирования и не используйте нижний/верхний регистр непоследовательно. Например, getUserName, GetUserName, getusername

Пример для языка Java:

a) используйте смешанный регистр для имен методов: getStudentSchoolType

b) используйте смешанный регистр для параметров метода: setSchoolName(String schoolName)

15. Используйте смысловые имена для параметров метода, в этом случае такое имя будет «документировать» метод, если явная документация отсутствует.

Оригинал статьи


Комментарии:

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Можно использовать следующие HTML-теги и атрибуты: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>