Какие существуют нотации(правила именования) в программировании?

Question

[Ann As]

Я встречал два типа нотации:
- camelCase;
- under_score.
На основании вышеупомянутых видел комбинации стилей.
За и против, как я понимаю - это сугубо личный вопрос (индивида, компании). Что используете вы? Я завтра уже буду использовать скорректированный стиль, основываясь на источнике.

Я изучаю программирование пару месяцев. Сейчас в Java использую такие соглашения:
1. переменная int iValue = 0; (в префикс ставлю первый символ типа);
2. переменная экземпляра int m_iValue = 0; (встретил в книге С.Праты)
3. функция/метод: camelCase;
4. классы: CamelCase;
5. объекты: obj_jlabName = new JLabel(); (что-то похожее в книге у Г.Шилдта про Swing).

Вывод № 1: Самодокументируемый код. Источник - пост и комментарии к этому вопросу.
Вывод № 2: Чтение таких книг, как - "Совершенный код", "Clean Code".

Answer 1

[Армянское Радио]

Не вижу смысла в условиях современных IDE с подсветкой синтаксиса, засовывать информацию о типе и принадлежности классам в название переменной.

-меньше абракадабры
-больше читаемости и самокомментирующего кода

Comments

[Ann As]

Да, я думаю не использовать префиксы принадлежности к классам и типам. По крайней мере работая в IDE. Обучаясь основам C/C++ в "code blocks" без указания префиксов было тяжело.

[Армянское Радио]

Разработка без IDE? Как там в 2002, на AMD уже можно жарить стейки?

[Ann As]

Армянское Радио: Сейчас IntelliJ IDEA )))

Answer 2

[Сергей Протько]

с переменными вида obj_jlabName вы код ревью не пройдете у подавляющего большинства разработчиков. Именуйте переменные адекватно, что бы можно было определить что в них. Завязывать имена переменных на модификаторы доступа (вообще все стоит делать приватным), или тип. Вы и так явно задаете тип, просто не пишите код так, что это бы вызывало двусмысленность. Ну и определение переменных должно быть рядом с их использованием, никаких методов на 100+ строк, если хотите добавить комментарий перед блоком кода - лучше вынести это добро в отдельный метод...

Словом, называйте все своими именами, и будет вам счастье.

Comments

[Ann As]

Спасибо. Взял на заметку "...если хотите добавить комментарий перед блоком кода - лучше вынести это добро в отдельный метод..." т.к. на неделе читал об этом.

[Сергей Протько]

Artem Solovev: путь к гормонии и счастью лежит через самодокументируемый код. Ну и самотестируемый, то есть покрытый юнит тестами. Код намного чаще читают чем пишут, и нужно упрощать именно процесс понимание что делает читаемый код.

[riot26]

Artem Solovev: обязательно к ознакомлению "Чистый код" Мартина. Бегло прочитайте, а позже вернитесь к ней ещё раз и прочитайте более тщательно.

[Сергей Протько]

Дядю боба надо очень осторожно читать. Идеи у него правильные но весьма категоричные. В этом плане стоит после сразу почитать чего-нибудь из фаулера по рефакторингу и в целом его заметки на тему traidable quality.

[Ann As]

riot26: Спасибо за рекомендацию! Занес в список. С этих выходных начну прочтение.

Answer 3

[Dimonchik]

https://www.youtube.com/watch?v=z5WkDQVeYU4

Answer 4

[xmoonlight]

Кратко: Именуйте так, чтобы смысл переменных (код) был понятен не только Вам.

Answer 5

[romy4]

пункты 1,2 и 5 это ужас и прошлый век.

Comments

[Ann As]

Да, завтра уже применю полученные рекомендации. Спасибо.

Answer 6

[Олег Цилюрик]

Я изучаю программирование пару месяцев.

Предлагаю, для большей плодотворности обозначенной дискуссии, вернуться к ней ... лет через 10. ;-)

P.S. А вы пока изучайте программирование ...

Answer 7

[abs0lut]

Сейчас в Java

В Джаве свое соглашение об именовании, как и у большинства языков. Это не место для творчества или демонстрации индивидуальности.

1. переменная int iValue = 0; (в префикс ставлю первый символ типа);

извращенство

2. переменная экземпляра int m_iValue = 0;

извращенство

(встретил в книге С.Праты)

первый раз слышу

5. объекты: obj_jlabName = new JLabel();

извращенство