Javascript-форум - Большие комментарии это хорошо или плохо?

Javascript-форум (https://javascript.ru/forum/)

- Оффтопик (https://javascript.ru/forum/offtopic/)

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

Большие комментарии это хорошо или плохо?

Вот собственно мой код https://github.com/iMaxmaxmaximus/fi...r/build/fix.js

А что если добавить теги и картинки вхуяривать в jsdoc или фильмы с ютьюба с примерами использования?? О_О

:lol:

Цитата:

А что если добавить теги и картинки вхуяривать в jsdoc или фильмы с ютьюба с примерами использования?? О_О

Большие коменты это хорошо, лучше чем без коментов.
В общем чтобы не быть извращенцем сделай две версии. С большими коментами для полного понимания и версию без них(или не такими большими) для загрузки, чтобы сразу прицепить к сайту, не удаляя твои килобайты лишнего)

l-liava-l, ты типа про компиляцию не знаешь?
Я имею ввиду в исходниках это ухудшает чтение и понимание кода или улучшает?

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

Цитата:

Сообщение от Dim@

просто есть люди которые не любят больших комментариев

да да да, много я ко ко ко на хабре слышал что хороший код это код без каментов, когда все и так понятно из названий функций. Но по моему это бред, абстракции надо поднимать в каментах, СМЫСЛ функций надо описывать в каментах, как сделал я, вот в реализации не должно быть комментариев разве что в местах требующих уточнения и пояснения логики, вот я о чем. Мы же работаем с языком на уровне функций и методов. По этому надо описывать их чтобы при нажатии ctrl и наведении на метод показывалась его дока и.т.п. )

ну лан, кстати оцените код и его понятность, и структуру кода в целом, это пойдет в портфолио..
https://github.com/iMaxmaxmaximus/fix

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

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

Есть некоторые расхождения в стиле от ф-и к функции

Код:

} else {

Код:

}

        else {

тут тоже перевод строки лишний

Код:

for (var property in css) {

                element.style[property] = css[property];

        }



        return element;

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

Код:

Notifier.HEADER_TEXT = 'Вообще-то, :';

Notifier.DETAILS_TEXT = 'Что именно не поддерживает мой браузер?';

Notifier.CLOSE_TEXT = 'закрыть';

Код:

if (key in target)return;

где пробел?

Код:

var fix = new Fix;

var notifier = new Notifier;

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

Код:

for (var i = 0; i < elements.length; i++) {

        if (elements[i] === this) {

                return true;

        }

}

Код:

for (var i = 0; i < elements.length; i++) if (elements[i] === this) {

        return true;

}

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

Хз, так то нормально, но я стараюсь всё до каждого символа вылизывать.

Tim,
да форматирование вещь такая :lol:, вот стал писать месяц назад форматированным кодом - и не трудно, и приятно читать

Tim, ты прикалываешься? там такого нет О_О

Цитата:

Сообщение от Tim

Экономь место по вертикали

всегда считал что нужно экономить место по горизонтали О_О

Цитата:

Сообщение от Tim

сделай один var

ни когда не буду делать один var так как это не очевидно

выровнять по ровно не знаю как(( я вообще форматированием кода не занимаюсь, 21 век, этим занимается PhpStorm ((
а он не умеет выравнивать по ровно(

Я делаю акцент на ОЧЕВИДНОСТИ, то есть мне даже не лень написать лишний раз

if( ololo instanseOf Ololo === false )

чем убогое

if( !(ololo instanseOf Ololo) )

megaupload,
мдаа я наверно бы сделал бы акцент на лаконичность

if( !(ololo instanseOf Ololo) )