LINUX.ORG.RU
ФорумTalks

Философия идеального кода: нужны ли комментарии?


0

4

Вопрос кроется в заголовке.

Иллюстрация (и ответ): http://img17.imageshack.us/img17/2053/64762894.png

Очевидно, что смысла писать комментарии методов нет. Тем не менее, во многих «конторах» за отсутствие комментариев подобного рода по головке не погладят.

Классический пример библиотеки вообще без комментариев mybatis - и, что примечательно, пользоваться ей одно удовольствие!

Ответ на: комментарий от moscwich

Для одной команды они не нужны

javac так не думает. Реализация функции в Java должна быть заключена в фигурные скобки независимо от количества комманд.

Чудный этот ваш ООП...

Чем это он чудный?

(хотя хз как там у java, в js вроде так).

JavaScript никак не относится к Java - это абсолютно разные языки.

Deleted
()
Ответ на: Fuuuu от moscwich

Если уж анонимус такой задрот, что ему надо ради одного действия сделать функцию

А что, это уже что-то плохое?

PS. По всей видимости, данная функция - банальный геттер.

Deleted
()
Ответ на: комментарий от Deleted

JavaScript никак не относится к Java - это абсолютно разные языки.

Спасибо, Кэп.

javac так не думает. Реализация функции в Java должна быть заключена в фигурные скобки независимо от количества комманд.

А в случае с if нормально? Да, ерунда такая с функциями (только с ними) и в php.

moscwich
()

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

Мне лично глазами коментируемый код легче парсить, чем тот же но без коментариев. Для eclipse есть такой вот плагинчик http://jautodoc.sourceforge.net/, который позволяет генерировать коментарий исходя из названия метода. Хотя я привык руками писать, так как работаю не только с Java.

anonymous_
()
Ответ на: комментарий от Vernat

каждый из которорых можно воплотить в понятный код

Чтобы понять код, нужно понимать, что этот код делает в общих чертах. Потому что если на входе я имею набор точек и на выходе набор некоторых многоугольников, а внутри будет много-много переменных вида if_we_can_turn_right[N], то понимабельность будет низкая, и код будет плохо читаться стороннему человеку.

cvs-255 ★★★★★
()

Если код идеален, комментарии к нему излишни :)

const86 ★★★★★
()
Ответ на: комментарий от gagarin

Real programmers don't comment their code. If it was hard to write, it should be hard to understand.  — unknown

Это фраза от Tom Van Vleck. Из серии «реальные программисты XXX».

P.S.

Real Programmers don't write specs — users should consider themselves lucky to get any programs at all, and take what they get.

kim-roader ★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.