Javascript-форум (https://javascript.ru/forum/)
-   Оффтопик (https://javascript.ru/forum/offtopic/)
-   -   Большие комментарии это хорошо или плохо? (https://javascript.ru/forum/offtopic/37694-bolshie-kommentarii-ehto-khorosho-ili-plokho.html)

megaupload 02.05.2013 21:35

Цитата:

Сообщение от Dim@
мдаа я наверно бы сделал бы акцент на лаконичность

компилятор не, не слышал?

код пишется ДЛЯ ЛЮДЕЙ и , как мне кажется === false очевиднее восклицательного знака, и я где-то уже писал что у восклицательного знака смысл больше не отрицание а "реверс"

tenshi 03.05.2013 10:14

> Я имею ввиду в исходниках это ухудшает чтение и понимание кода или улучшает?

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

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

Это идеал, к которому стоит стремиться.

> Не до комментариев, с форматированием кода сначала разберись

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

> Тут я бы выровнял по знаку =

Мартышкин труд. Если редактор умеет выравнивать по равенсту - замечательно. Иначе это бесполезные рюшечки.

> где пробел?

Какой ужас, не хватает пробела))

> сделай один var и выровняй по =

С ветками никогда не работал? При слиянии оных _крайне_ удобно, когда строки синтаксически друг от друга не зависят.

> Не красиво из-за разной длины переменных? подбери имена получше!

Ага, все имена должны быть ровно 4 символа и всё будет гламурненько)

> так вроде лучше. нет?

Лучше так:

for (var i = 0; i < elements.length; i++) {
    if (elements[i] !== this) continue
    return true
}


> у восклицательного знака смысл больше не отрицание а "реверс"

Это твои личные неправильные ассоциации) И чем "логическое отрицание" не "реверс" - не понимаю.

Tim 03.05.2013 10:34

tenshi,
megaupload,
говнокодеры :D

megaupload 03.05.2013 11:29

Цитата:

Сообщение от tenshi
Это идеал, к которому стоит стремиться.

То есть я идеале в jsdoc описания нет?

Цитата:

Сообщение от tenshi
Ага, все имена должны быть ровно 4 символа и всё будет гламурненько)

вот вот и действительно, зачем основывать именование на ЛОГИЧЕСКОЙ ЧАСТИ, главное это как код смотреться на фоне моей новой сумочки будет... лол, по моему это самый ебанутый совет был бро, безобид)
Но все ровно всем спасибо что помогаете нубу

Цитата:

Сообщение от tenshi
Лучше так:

ха, точно) мы же "от обратного" всегда идем в иафх, забыл, спасибо)

Цитата:

Сообщение от Tim
говнокодеры

Tim,
почему говнокодеры? вот скажи ты чо код вручную форматируешь, правда)???

tenshi,
блин, дааа)) клеева


Tim 03.05.2013 11:44

Цитата:

вот скажи ты чо код вручную форматируешь, правда
нет, так же как и ты - штормом, но он не всё умеет

megaupload 03.05.2013 11:54

Цитата:

Сообщение от tenshi
Это твои личные неправильные ассоциации) И чем "логическое отрицание" не "реверс" - не понимаю.

toggle = !toggle здесь мы переключаем toggle и делаем реверс

а здесь
if(toggle === false) мы проверяем, если toogle равен false то сделаем что-то.

если бы мы написали if(!toggle) то нам бы в уме пришлось просчитывать логическое действие реверс toggle

Дело в том то что if принимает true и мы хотим получить туда true..
Делать это путем реверса??? Не кажется ли это вам костылем?
Не лучше ли писать код как ты думашеь

если в toggle лежит ложь то...
if( toggle === false )


а не

если отрицать toggle и сделать его реверс, то...
if( !toggle )


понимаете о чем я?

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

например сравните if(!(keys instanceof Array)) и if(keys instanceof Array === false)

Цитата:

Сообщение от Tim
но он не всё умеет

но он же портит твое выравнимание О_О не?

tenshi 03.05.2013 12:12

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

Угу, это бесит, особенно с instanceof. Другое дело, что instanceof имеет смысл использовать лишь в очень редких случаях. Тот же instanceof Array будет не со всеми массивами давать true.

> if(toggle === false)

Тогда уж if(toggle !== true) потому что toggle может оказаться равен undefined

tenshi 03.05.2013 12:14

> То есть я идеале в jsdoc описания нет?

В идеале вообще jsdoc-а быть не должно) Но это уже TypeScript какой-нибудь нужен.

megaupload 03.05.2013 15:33

Цитата:

Сообщение от tenshi
Тот же instanceof Array будет не со всеми массивами давать true.

да ладно а можно пример?

Цитата:

Сообщение от tenshi
Тогда уж if(toggle !== true) потому что toggle может оказаться равен undefined

не может у нас jsdoc и {boolean} а в случае когда может быть а может и не быть то можно и if(!toggle)
... чо то я загнался)

Цитата:

Сообщение от tenshi
В идеале вообще jsdoc-а быть не должно)

не путаешь ли ты (и я) jsdoc (документацию) с комментариями)?

tenshi 03.05.2013 21:37

> да ладно а можно пример?

В разных фреймах разные объекты Array.

> не путаешь ли ты (и я) jsdoc (документацию) с комментариями)?

А в чём принципиальное отличие?)


Часовой пояс GMT +3, время: 14:27.