oowl Sep 1 2008 at 02:26

Ваш стиль именования переменных

1 min

19K

Website development*

+30

Comments 90

rill Sep 1 2008 at 02:57

number_favorite_news для переменных
numberFavoriteNews для функций
numberFAVORITENEWS для классов
Привык так :)

rill Sep 1 2008 at 02:58

сорри забыл. Пишу на C++

RedOctober Sep 2 2008 at 05:26

> numberFavoriteNews для функций

т.е. у тебя названия функций начинатся с маленькой буквы?
Странно.

-1

Caesar Sep 2 2008 at 09:57

почему странно?
а если это методы?

RedOctober Sep 2 2008 at 17:52

а какая разница между методом и функцией? (на C++ я не писал, только на C#)

Caesar Sep 2 2008 at 18:50

метод — функция в составе класса.

На самом деле меня больше интересует ответ на первый вопрос: «почему странно?»

xnodev Sep 6 2008 at 15:11

Метод — функция не возвращающая значения, да будет вам известно

-2

dbf Sep 6 2008 at 15:13

Это процедура не возвращает вообще-то :)
RTFM.

xnodev Sep 7 2008 at 00:57

А чем процедура от метода отличается?

Mercury13 Sep 1 2008 at 02:57

Как предпочитаю на Си/Java:
this_is_variable
ThisIsFunction()

-1

ZeLeBoBa Sep 1 2008 at 03:23

Для Java есть оффициальные соглашения об именовании/

khim Sep 1 2008 at 10:42

У этих соглашений есть только одна проблема: читать неудобно. Но лучше уж общие для всех более-менее соглашения, чем каждый — со своим, очень удобным, велосипедом.

-6

Polymorph Sep 1 2008 at 21:54

Можно со своим «велосипедом», но так, что кто бы не взглянул — всем понятно.

Polymorph Sep 1 2008 at 21:55

Тьфу, ошибку в «не» сделал, знаю =)

Seldon Oct 22 2013 at 15:42

В java есть функции?

klyavin Sep 1 2008 at 03:07

первый вариант для всего — нравится также третий, но в текущем проекте начал с первого, поэтому выдерживаю стилистику :)

klyavin Sep 1 2008 at 03:49

ах, да, забыл — константы SOME_CONST

kronos Sep 1 2008 at 03:10

ClassName
class_method
local_var
@object_var
@@class_var
$global_var
Ruby

+12

mx2000 Sep 1 2008 at 03:17

Опросник с подвохом)

1. Если речь идет о локальных переменных — однозначно my_local_variable
3. Глобалы, имена классов — MyVariable, MyFooClass
4. Константы — MY_CONSTANT

Вроде ничего не забыл?

maxshopen Sep 1 2008 at 03:24

className — классы
$iCount — переменные
$CONF — константы
^getVar[] — методы
field_name — поля форм, БД и переменные внешних языков (js например)

Parser 3

-1

Pirate Sep 1 2008 at 04:16

Интересно, а длина имени переменной влияет на скорость выполнения скрипта? Интересует именно ActionScript.

rumkin Sep 1 2008 at 05:08

Так же как длинна обеденного перерыва, на вкус обеда.

wpm1 Sep 1 2008 at 12:52

ну можно привести пример в котором влияет) когда там работа с какими нибудь eval конструкциями зацикленными, так, чтобы постоянно приходилось плодить экземпляры парсера на каждом проходе. тогда действительно повляет длина вводимого кода. но это гон ведь какой-то получится)

-1

Termos Sep 9 2008 at 09:06

Для public методов и полей и для не финализированных protected разница есть, так как флеш плейер для оперирования ими использует стринговые хеши, их имена сохраняются в swf и swc файлах, сохраняются и при декомпиляции.
Для локальных переменных, private и final protected методов используется другой инструментарий, который оперирует численным дескриптором ссылки на объект — работает быстрее, стринговое имя уничтожается при компиляции и скорость и вес конечного приложения не зависит от длинны исходно имени.

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

Seldon Oct 22 2013 at 15:44

Идите почитайте срочно об интерпретации, компиляции и выполнение программ

iAndrej Sep 1 2008 at 05:03

Стиль именования зависит от языка, на котором пишешь в данное время.

dals Sep 1 2008 at 09:00

Я так думаю, стиль переменных зависит от соглашений по форматированию кода, принятого в текущем проекте команды.
Уточню. Даже если вы привыкли именовать переменные, допустим, $this_is_var, но стиль проекта $thisIsVar, то, как ни крути, вам придется принять общие условия.
И да, я придерживаюсь стиля №3, где это возможно.

khim Sep 1 2008 at 10:46

Стиль проекта, конечно, рулит, но стиль номер три можно было придумать только с большого бодуна. Ибо он, во-первых, непоследователен, а во-вторых плохо читается (нет промежутков между словами, достижения XVII века побоку).

-3

dals Sep 1 2008 at 11:13

Сколько людей — столько мнений. :)
Мне удобнее именовать так. И особенно удачно в сочетании с некими префиксами, например, $countApples = 0 либо, если устанавливаем какой-то флаг, $boolAppleGood = false
И так далее.
Разумеется, я не истина в последней инстанции и мой стиль, возможно, — ущербен. Однако никто не жаловался до сих пор. :)

f33l Sep 1 2008 at 23:05

зато снижается общий визуальный шум, уменьшается длина названий переменных.
и по-моему это как раз читабельнее — глаза скачут по большим буквам и слова рядом быстрее распознаются, нужно меньше напрягаться. уж если использовать «_» то писать тогда так: int_The_Good_Var

khim Sep 2 2008 at 10:01

Глаза плохо скачут по большим буквам. Не предназначены они для этого. Вот по пробелам — отлично.

rumkin Sep 1 2008 at 05:11

$var_name
className
classMethod
$classVar
fuctionName
$functionArgument
CONST
$if_var — переменные условия
$_private

iSlayter Sep 1 2008 at 10:23

$var_name
$if_var
$_private
CONST

class SomeController() {
public function SomeAction() {}
private function ValidateRegForm() {}
}

но

iSlayter Sep 1 2008 at 10:34

ой, случайно отправил.

но:
function_name()

если ф-я связана с файловой системой, то files_delete_dir_recursive(), например (т.е. начало ф-ии отражает направление её деятельности, как бы).

rumkin Sep 1 2008 at 10:57

Это новая идея для соцсети для программистов, поиск друзей по стилю оформления кода ;)

mikhanoid Sep 1 2008 at 07:16

если что-то используется во многих местах (глобальные переменные, поля различных структур), то полное имя в стиле:

the_var
the_function
the_type_t
the_class_c

Если переменная локальная, то короткие имена. Обычно, смысл понятен из контекста. Если не понятен, то короткое имя с комментарием.

Конечно, хотелось бы писать длинные имена в стиле:

someverylongname

который подчёркивает то, что работа идёт с целостным объектом. Но проблема в том, что не все люди способны быстро разбирать такой текст на слова.

someVeryLongName

диктует странные правила для переменных, в которых есть сокращения. Получается нечто вроде:

numOfTcpBins / numOfTCPBins
makeSdlScene / makeSDLScene

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

Ну, и естественно, на идентификаторы с подчёркиваниями можно натравить spell_checker.

khim Sep 1 2008 at 10:48

Изобретение пробелов в XVII веке ускорило чтение в два раза и позволило со временем придти к скорочтению. Удивительно как легко в XX веке программисты отказались от этого преимущества — причём в отрасли где «время == деньги», а программы чаще читаются чем пишутся… Для библиотек — намного чаще.

mikhanoid Sep 1 2008 at 21:01

Кстати, исходники plan9 написаны в стиле: somelongname, но читаются почему-то очень легко. При чём даже неопытными людьми. Такое вот исключение из правил. Там, наверное, какое-то Дао присутствует.

-1

UFO just landed and posted this here

Wonder Sep 1 2008 at 07:50

sNameOfVariable — для строковых переменных
iNameOfVariable — для числовых и т.д.

kulikoff Sep 1 2008 at 09:14

Сразу видно своих людей в толпе.
Миша почти всех подсадил :)

-1

w0lf Sep 1 2008 at 09:31

Кодирование типа переменной в имени — Бейсиком отдает имхо :) А если серьезно, работал я в одном проекте, где в требованиях к имени переменных было указывать тип (a, v, s, f), тремя символами название модуля и потом уже имя переменной (функции). Получались довольно забавно: $v_cmn_ThisFuckingvariable хотя и не лишено некоторого смысла.

-1

kulikoff Sep 1 2008 at 09:43

Чем бы оно ни отдавало, но глядя в код я сразу вижу, что должно содержаться в этой переменной. И какие преобразования я могу с этим делать. Это действительно удобно, особенно когда лезешь в свой старый код. И к этому быстро привыкаешь.

Вобще в программировании важно выработать для себя определенные правила оформления кода. И приучить себя ими пользоваться. Тогда не испытываешь никаких проблемы разбирая свое же творение n-годичной давности :)

w0lf Sep 1 2008 at 10:28

То есть вы принципиальный противник менять тип переменной «на лету»?

kulikoff Sep 1 2008 at 10:36

Не совсем. Иногда это требуется, но все-таки я стараюсь, что бы в переменной $sMyString была строка и только, в $dtMyDate — дата и т.д. Так значительно проще и мне и тому, кому, возможно, придется в моем коде разбираться.

Если тип переменной заранее не известен или изменится, то это $uVariable (u — unknown)

zw0rk Sep 1 2008 at 10:56

А как быть в случае «классовых переменных»?

-1

kulikoff Sep 1 2008 at 11:17

Что именно имеется в виду?

zw0rk Sep 1 2008 at 11:30

$myKewlVar = new MyKewlClass();

kulikoff Sep 1 2008 at 11:40

$oNewObject (o — object)

f33l Sep 1 2008 at 23:57

а зачем? вам достаточно часто приходится это делать?
имхо вообще этого нужно избегать, чтобы не запутывать код.
в пхп например, использовать префиксы типов для переменных очень удобно, их мало:
i=int, f=float, fn=function(для коллбэков и динамических вызовов), s=string, o=object, a=array, h=hash(по вкусу), r=resource, b=bool, m=mixed(как раз, когда заранее не известно)
kulikoff писал, что использует u=unknown, однако mixed используется в мануале + например, в эклипсе, поэтому более предпочтителен

не понимаю, почему ветку минусуют, префиксы в языках типа пхп повышают читабельность кода. я тоже сначала косо смотрел, потом когда попробовал, привык мгновенно и потом оценил эффект.

Wonder Sep 1 2008 at 09:32

Ага, точно. Но удобно ведь!

khim Sep 1 2008 at 10:51

Если из названия переменной неясно что там хранится внутри — это плохое название, подумайте ещё. А в типах компилятор/интерпретатор разберутся лучше вас. Исключение — недоязыки типа PHP, где из-за идиотских попыток «облегчить» жизнь программистам на интерпретатор нельзя положиться.

f33l Sep 1 2008 at 23:32

ок, возьмем идентификатор. обычно пишут somethingId. обычно это int, но в некоторых случаях это может быть строка, например если это id сессии. однако, например у сессий селениума в старых версиях id сессии был целым числом, потом поменялся на md5-хэш.
итак, варианты:
— sessionId — когда я вижу это в коде, я сходу не понимаю что это, это может быть чем угодно
— sessionIdHash — md5-хэш? или ассоциативный массив с id'ами сессий?
— iSessionId, sSessionId — сразу ясно, не нужно вдумываться

при чем тут интерпретатор? префикс на него все равно не влияет, а код читают и поддерживают люди.

khim Sep 2 2008 at 10:04

— sessionId — когда я вижу это в коде, я сходу не понимаю что это, это может быть чем угодно

А оно вам важно? Думаю для понимания логики в 99% случаев — нет. А если где-то возникнет путаница, компилятор или интереретатор ошибку отловят.

Случаются такие казусы не так часто, а мусор для защиты от них вы создаёте по всему проекту.

scrat Sep 1 2008 at 08:14

колеблюсь между первым и вторым

Noofiz Sep 1 2008 at 08:29

1й — ПХП
2й — имена классов
3й — джава
4й — больше Си

khim Sep 1 2008 at 10:58

Си это скорее 1й вариант. Во всяком случае современный. А Си 70х-80х — это nfavnews чтобы в 8 символов название влезло. Не надо сейчас так писать, ограничения компиляторов давно в прошлом.

logman Sep 1 2008 at 10:15

Везде по разному. Зависит от языка в котором применяется и от роли переменной. например обычно у паблик и привэйт членов класса разные способы именования и т.п.

khim Sep 1 2008 at 11:01

Название переменной должно нести в себе информацию, которую другим путём получить сложно. Приватные/публичные переменные, имена классов и констант — всё это приличные редакторы могут выделить цветом/шрифтом без всяких усилий с вашей стороны и они сделают это правильнее (вам никогда не случалось переносить переменную из приватной в публичную часть?). Зачем эту информацию дублировать???

logman Sep 1 2008 at 12:29

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

khim Sep 2 2008 at 10:07

Я призываю не слишком усердстовать в этом процессе. И да — в идеале нужно бы все переменные называть одинаково. Но так как мы редко начинаем с нуля — то переносим в новые проекты старые привычки. Ничего плохого в этом нет, (кто-то верит в Иисуса, кто-то в Будду) — но нужно понимать что никакой объективной потребности в этих правилах наименования нет…

logman Sep 2 2008 at 10:39

Как уже выше замечалось, программисты большую часть времени читают код, а не пишут. Если каждый будет использовать свой стиль именования переменных/фуркций/классов и т.п., то в итоге на разбор работы системы, которую писали, например, человек 5 потратится намного больше времени, это мое личное мнение.
Давайте не будем больше спорить, а то это какой-то холивар получается :)

chEbba Sep 1 2008 at 11:40

юзаю 3ий для Ява
и его же для ПХП (ибо использую Зендовсие договоренности, а они почти точь точь с явой совпадают =) )

sapl Sep 1 2008 at 11:56

как лучше именовать множественные значение
например фото пользователей: photosOfUsers || userPhotos || usersPhotos?

часто встречается еще такое лингвистическое именование: aName (добваление неопр. артикля)

mikhanoid Sep 1 2008 at 21:19

А смотря какой смысл вы вложить хотите в имя переменной. Если это множество состоящие из 'фотография пользователя', то user photos. Если это множество 'фотография пользователей', то users photos. Если это множество фотографий множества пользователей, то photos of users. Хотя, тут надо спросить более сведующего в языке человека. Но, по идее, так должно быть.

А вообще, самый удобный язык для программирования — это Эсперанто. Там полная определённость со всеми падежами, числами и структурой словосочетаний.

akzhan Sep 1 2008 at 21:57

aName, anApplication — принято в Borland Pascal для именования параметров методов/функций :)

поля объектов именуют с заглавной буквы F.

А в C#, например, поля объектов начинаются с _.

anycolor Sep 1 2008 at 12:19

Конечно только «кемел-стайл» (венгерская нотация?), тоесть вариант 3. PHP/Java

akzhan Sep 1 2008 at 21:55

а венгерская нотация тут причём?

ей уже давно не пользуются, в процессе перехода от C к C++ потребность указания типа переменной в её имени полностью пропала.

Mad_Fish Sep 1 2008 at 21:16

C++

class CSomeClass;
void SomeFunction();
int someVariable;

akzhan Sep 1 2008 at 21:54

Зависит от:
1) языка разработки;
2) стиля программирования в конкретном проекте.

Для .NET, JavaScript, C++: camel case.
Для Perl — underscore_separated.

f33l Sep 2 2008 at 00:08

вот еще размышления по теме:
local.joelonsoftware.com/mediawiki/index.php/Как_заставить_неправильный_код_выглядеть_неправильно

Goodkat Sep 2 2008 at 00:37

lf_some_local_var
lt_some_local_tab — локальный массив
gf_some_global_var — глобальная переменная
p_something, so_something — параметры
if_some_var — параметры функции
ef_some_var — результаты функции

пирожок тому, кто угадает язык программирования :)

veevtam Sep 2 2008 at 00:43

class_name
method_name
function_name
$var_name

PHP

-1

mryasov Sep 2 2008 at 01:01

для понятного кода:
$iInteger — целое чило
$fFloat — число с плавающей точкой
$bBoolean — булева переменная
и т.д.
+ комменты, и будет вам счастье )

ну, т.е. «префикс» перед переменной должен совпадать с ее типом

p.s.: maxshopen, Вас поддерживаю. к сожалению, заметил на хабре тенденцию к ненависти парсера )

-1

mx2000 Sep 4 2008 at 02:04

это типа венгерской нотации что ли? Забудьте про нее. Вас научили совершенно не тому, для чего она была создана :)

mryasov Sep 4 2008 at 09:57

Подумайте о логике!
Вам легко разбирать чужие коды, где переменные именованы по типу $nlo1 и $nlo2?
или Вы так и пишите? оО

Или, к примеру, $my_variable_first_hash и $my_variable_first_integer.
не проще будет разобраться в переменных типа $hFirst и $iFirst?

mx2000 Sep 6 2008 at 05:49

Не проще. Переменные следует именовать согласно их назначению, и префикс или суффикс, несущий в себе тип переменной — это последнее, что я хочу знать об этой переменной.

Повторю еще раз: венгерка была придумана для указания НЕ ТИПА переменной, а для указания ВИДА переменной, т.е. СУТИ того значения, которое содержится в переменной. Почитайте [дважды] статейку «Making Wrong Code Look Wrong» за авторством Joel Spolsky — Вы всё поймете и перестанете писать эту ересь в коде ;-)

q_styler Sep 2 2008 at 01:23

private $m_Member;

function ($p_Parameter)
{
$l_Local = $p_Parameter;
}

-1

q_styler Sep 2 2008 at 01:24

ой, а функции название дать и забыл
пусть будет
function mySuperDuperCoolFunction($p_Parameter);

Bugblind Sep 2 2008 at 01:23

Для Javascript numberFavoriteNews
Для PHP number_favorite_news

Vadun Sep 2 2008 at 02:07

C++:
class SomeClass
{
public:
void Method(int someArg)
{
int someLocal;
}

private:
int _somePrivate;
};

TeAnton Sep 2 2008 at 04:38

C++
NumberFavoriteNews для имени класса
numberFavoriteNews для публичных членов класса
numberFavoriteNews_ для защищенных членов класса
NUMBER_FAVORITE_NEWS для констант

Object Pascal
TNumberFavoriteNews для имени класса
NumberFavoriteNews для публичных членов класса
FNumberFavoriteNews для защищенных членов класса
NUMBER_FAVORITE_NEWS для констант

chiaroscuro Sep 2 2008 at 07:55

в Лиспах и XSLT:

foo-bar

в языках с C-style синтаксисом:

fooBar

в Хаскеле и Окемле:

fb (а когда нехорошее настроение, называю одну переменную f, вторую ck, и перемножаю их вот так: f*ck)

konnikov Sep 2 2008 at 08:27

для Java:
ClassName
varMane
methodName()
CONST_NAME

ofigenn Sep 2 2008 at 10:29

ВЕРБЛЮД, только верблюд + BSD!

grumbler_chester Sep 2 2008 at 11:37

Наверное, все-таки индивидуальный стиль диктуется первым «серьезно используемым» в работе языком. По своему опыту: писал на яве, сейчас программировать практически перестал, иногда приходится писать скрипты на питоне, и при их написании «непроизвольно» применяю java-оформление. Конечно лишь в тех случаях, когда скрипт пишется для себя, а не «наружу».

jaffa Sep 2 2008 at 12:55

классы — MyClass
переменные — myVar
private поля класса — _myField
методы — MyMethod
интерфейсы — IMyInterface
свойства — MyProperty
константы — MY_CONSTANT

язык — C#

так имхо и читать удобно и неразберихи не будет

redhummer Sep 6 2008 at 06:37

классы — Some_MySuperClass
методы классов — someSuperMethod

Переменные:
строковые, числовые и булевые — some_value
массивы — aSomeArray
объекты — oSomeObject

Теперь уже знаю, что для обозначения объектов и массивов следовало бы использовать другие буквы, но учить было некому и потому придумал себе сам такой стиль. удобно )

VasilioRuzanni Sep 6 2008 at 06:52

Классы — MyClass
Методы — MyClassMethod
Тесты к методам — MyClassMethod_SomethingMustHappenTest (где SomethingMustHappen — краткое описание некоего условия, проверяемого тестом).

Переменные — value, justValue, someValue и так далее. Никаких венгерских нотаций. То же самое касается массивов и других объектов, помимо простых переменных. Бывает изредка экземпляры классов начинаются с «o» или obj (а ля oSomething или objSomething).

Ну и, имея в виду то, что код я сам не пишу уже несколько лет :), надо думать ребята из технологического направления еще что-то напридумывали. Но базовые правила соблюдаются и проверяются fxCop'ом.

P.S. Да, языки C#, JavaScript, ActionScript 3.0.

UFO just landed and posted this here

Show the best of all time