Самый главный гайдлайн при написании кода — это отбивать реализации методов несколькими пустыми строчками и строкой-комментарием. Несмотря на возможности современных IDE по поиску и структуризации исходного кода, визуальное ориентирование все еще играет важную роль.
Рассмотрим пример ниже. Есть реализация класса на языке Objective-C. Методы отбиты всего-лишь одной строкой. Также отбивка одной строкой встречается не только между методами, но и между логическими блоками кода внутри методов. Длинна названия метода не может служить хорошим ориентиром начала нового метода. Например, название метод stopProgressAnimating короче любой строки предыдущего метода loadCommentsFailure. Глазу не за что зацепиться.
Тот же самый код, но методы отбиты пустыми строками и комментарием. Теперь место между концом одного метода и началом следующего образует однородный узор, который постоянно повторяется. Такой узор легко обнаружить даже при быстром скролировании.
Сообщения
Почему бы вместо занятий форматированием не научить вашу иде элементарным вещам?
ОтветитьУдалитьПотому что, если код правильно отформатирован, читать его легче в _любой_ IDE.
УдалитьВ петоне, кстати, по PEP8, нужно делать 2 пробела между методами, а блоки отделять максимум одним пробелом. Получается неплохо видно без строки комментариев.
УдалитьНу ты с Vim мучаешся, это понятно..
УдалитьРазделение, конечно, очень «ok» — сам долгое время этому следовал. Но в последнее время предпочитаю банальный doxygen комментарий перед методом. Пусть он будет и примитивным, но не будет нарушать концепцию визуального ориентирования (типа что перед методом doxygen коммент всегда). И получается одним махом двух зайцев убиваешь: и комментарий перед методом стоит (который может описывать какие-то особенности метода) и визуальная навигация работает. :)
ОтветитьУдалитьПоследние пару лет использую другой разделитель, мне так больше нравится, еще больше подчеркивает структуру визуально:
ОтветитьУдалить/*------------------------------*/