вот почему я стараюсь не комментировать на русском

[Фанат]

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

 

[флоппик]

Комментарии на русском меня, кстати, несколько смущают _при чтении_, т.к. когда у меня мозг в programming mode, я мыслю по-анлийски, а лишнее "переключение" на мышление по-русски и обратно заметно выбивает из потока.

я конечно, не полиглот, но английский имеет более чёткую и устоявшуюся, а главное, однозначную терминологию, нежели русский. Хотя я сам фанат русского языка, и борец за становление четкого русского терминологического запаса, но в любом случае, мне не интересны «потоки сознания» и паника непонимания самим собой же написанного кода какого то неизвестного разработчика. Комментирую я мало, считаю, что писать комментарий к например, функции с именем db_connect() - это идиотизм.
Комментироватся должны неочевидные куски кода, причем - вкратце, что взяли, как обработали, что получили. Этого прекрасно хватает для понимания и дальнейшей работы.

 

[Духовность™]

жаль что форум не смог отобразить японский

Почитал дискуссию.

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

Много кода я вообще не комментирую, т.к. работаю не в команде.

Да и зачем писать комментарии на английском, если 99% вероятности того, что поддерживать программу будут русскоязычные разработчики?

ИМХО - писать комментарии на английском, если это не обусловлено необходимостью - выпендрёж. Потеря рабочего времени и необоснованные затраты.

 

[флоппик]

зачем писать комментарии на английском

английский имеет более чёткую и устоявшуюся, а главное, однозначную терминологию, нежели русский

 

[Духовность™]

английский имеет более чёткую и устоявшуюся, а главное, однозначную терминологию, нежели русский

Причем тут терминология? Терминология к комментариям никоим боком не может относиться. Комментарии - это описание действия кода. Вы не можете описать по-русски что ваш код делает?

 

[Alexandre]

Да и зачем писать комментарии на английском, если 99% вероятности того, что поддерживать программу будут русскоязычные разработчики?

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

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

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

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

а комментарии на японском (или китайском) выглядят просто обескураживающе.

 

[TutanXamoN]

У меня сейчас к комментариям отношение достаточно специфическое -
1. Если я работаю сам над проектом - я себе пишу комментарии вида "это надо переписать" в органайзере ибо вероятность что после написания того что работает, но его нужно переписывать я к этому вернусь без веской причины (а-ля не работает) крайне мала.
2. Если это команда - я не вижу смысла комментирования КОДА. Объектов, методов - да, но не кода. Скрипты такого вида ИМХО маразм:

....
$dbname=""; //place here your database name
....

3. Язык комментирования есть достаточно объемной темой без однозначного варианта в каждом случае.
Моё субъективное - английский. Ибо с русским бывают проблемы различного рода. (сколько людей на меня иногда ругались когда я по их просьбе модифицировал скрипт через криво настроенную админку не выводившую русские комменты и сохраняющую кракозябры >_<).

Если брать глобально я не люблю комментарии в коде там где это не надо, а надо в очень редких случаях + иногда в шапке файла со скриптом. Я больше люблю ОТДЕЛЬНУЮ документацию к коду/апи

 

[Alexandre]

Я больше люблю ОТДЕЛЬНУЮ документацию к коду/апи

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

 

[ustas]

Пишу на русском и буду писать, что мозги то ломать? Как правило их читать население англоязычных стран не будет, нахрена спрашивается?

 

[флоппик]

я себе пишу комментарии вида "это надо переписать"

/*
* TODO:
*/
В нетбинсе вполне себе распознается и падает в закладку tasks.

 

[weregod]

TutanXamoN
> Если брать глобально я не люблю комментарии в коде там где это не надо, а надо в очень редких случаях + иногда в шапке файла со скриптом. Я больше люблю ОТДЕЛЬНУЮ документацию к коду/апи
а чем не устраивают автодокументеры кода и IDE, которые исходя из

/**
 * @var SomeClass
 */
private $someObject;

при обращении к $this->someObject-> перечислят все публичные методы/свойства автоматически?

 

[TutanXamoN]

weregod
Устраивает. О чём я и говорю - мне гораздо проще, понятнее и приятней читать вывод автодокументеров чем лазить по скриптам в поиске необходимого класса/метода и комментария к нему.
Просто в связи с тем что обсуждая данную тематику мы достаточно сильно углубились в понятия необходимость/востребованность/удобство я решил выразить свою точку зрения касательно момента ознакомления с новым кодом.

 

[weregod]

TutanXamoN, понял, в выходные моя голова была на выходных

 

[nw]

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

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

Я лично для себя выбрал такой вариант: писать очень кратко (2-7 слов) на английском всегда. Но это не потому что так "правильно", а потому что это удобно лично для меня и вполне понятно коллегам.

-~{}~ 08.05.09 11:15:

тут делать спинаверх база данных

Кстати, если на той стороне кода будут не native англоговорители, то они отлично поймут о чём идёт речь.

 

[StUV]

если на той стороне кода будут не native англоговорители

да и нативные тож поймут
мы же понимаем (примерно) о чем это:

тут делать спинаверх база данных