caxapa.ru :: ..заметки в комментариях сильно перегружают. Код, как ни странно, плохо читается.

blackbit (02.11.2010 04:14, просмотров: 170) ответил Красный Свин на Как показывает моя практика, надо быть проще :)

..заметки в комментариях сильно перегружают. Код, как ни странно, плохо читается. Смотришь порой на страницу - там 5-10 строк кода, а все остальное заметки/комментарии. За этими кустами и деревьев (остальной код) не видно. Может это и хорошо для тех, кто сначала читает комменты, а потом остальное, но не для всех.. Было такое старое правило стиля для С - код всей функции (блока) должен помещаться целиком на странице и только если останется место, заполнять комментами и заметками. P.S.: Впрочем, еще такой подход годится для всяческих .ini файлов настроек.

Ответить

- Да-да, а еще комменты внутри циклов замедляют их исполнение.. Если не хочется видеть много блочных комментов - откройте для себя редакторы с Code Folding, типа Ультраедита. - Красный Свин(02.11.2010 23:40, )
  - Уже не раз всречаю эту фразу. Объясните, пожалуйста, как комменты могут влиять на работу программы?! - mazur(10.11.2010 14:05)
    - это придется вам постичь самому. - bialix(10.11.2010 14:25)
    - грамматические ошибки в комментах раздражают компилятор и он от огорчения может забыть оптимизировать что-нибудь - Snaky(10.11.2010 14:08)
      - Если что-то коммент, то компилятору пох что там написано. Хоть мурку там наизусть пиши. Ваша фраза - шутка? Мож я чего-то и не знаю..... - mazur(10.11.2010 14:10)
        
        Вот пример, когда не пох (довольно частая ошибка): testerplus(185 знак., 12.11.2010 12:16)
        
        Из-за чего здесь будет ошибка? Попробую угадать. Два варианта. readme.txt c:\doc\ - mazur(12.11.2010 12:26)
        
        Обртный слеш в конце строки говорит за то, что следующая строка - продолжение комментария в текущей. Дргуми словами "return BAD" окажется частью комментария - testerplus(12.11.2010 12:58)
        
        Тонко подмечено! Вот почему я настаиваю, чтобы наши программеры все каменты оформляли /* ... */ - Evgeny_CD(12.11.2010 13:08)
        
        При оформлении в таком стиле сложнее временно целыми блоками комментарить. Приходится что-то типа #if 0 использовать, но при этом блок уже не подсвечивается как закомментированный. - rezident(12.11.2010 15:14)
        
        За "закоментаривание" вместо #if 0 -- людей сжигать нужно (C). Если не подсвечивается -- нужно взять номальный редактор. А то в wordpad вообще ничего не подсвечивается. За закоментаривание путём // -- сжигать 2 раза. - fk0(12.11.2010 15:51)
        
        большая часть редакторов подсвечивающий каменты в стиле // /* всякие умные #if 0 не понимают. городить монстра типа сликэдит - муторно. - Mahagam(12.11.2010 18:50)
        
        Это не повод говнокодить. И без подсветки жить можно. Большая часть -- это wordpad и notepad? Ибо подсвечивающих редакторов как бы не больше, чем не подсвечивающих... Редакторов, а не ноутпадов. - fk0(13.11.2010 15:30)
        
        обосновать гавнокодистость или кошерность разного вида закомментирования неиспользуемых кусков кода можете? - Mahagam(15.11.2010 13:09)
        
        C-комментарии не могут быть вложенные и вызывают глюки в таком случае. C++ комментарии вызывают сложности при обратном раскомментаривании (лишнего, вложенного и т.п.) и портят diff'ы. Речь, конечно не о закомментаривании 2-х строчек. - fk0(15.11.2010 13:20)
        
        вложенное закомментирование исходного кода - само по себе жуть. del на левый код и дело с концом. - Mahagam(15.11.2010 15:45)
        
        Ну возьмите Source Insight. Инсталлятор весит 3 МБ. Он даже препроцессор чутка понимает: Alex B.(106 знак., 12.11.2010 18:54)
        
        Про финских студентов еще забыли вставить. - rezident(12.11.2010 16:04)
        
        Советским профессиональным программистам, увы, до финских студентов ой как далеко. - fk0(12.11.2010 17:30)
        
        Имя нормального редактора? - AlexBi(12.11.2010 15:55)
        
        NetBeans понимает #if*, только для дефайнов в makefile ему нужно вручную в code assistance прописать то, что в makefile. Ну и то, что компилятор от себя ставит по ключам, скажем, __AVR_ATmega328P__. С #if 0, естественно, проблем вообще нет. - -ReAl-(12.11.2010 17:04, )
        
        SlickEdit 15 понимает #if 0 - Alex B.(12.11.2010 16:22)
        
        Попробовал в 14-ом. Тоже понимает, а я не знал. - AlexBi(12.11.2010 16:25)
        
        (G)Vim - fk0(12.11.2010 15:58)
        
        Это не делает вам чести как руководителю. Лучше бы вы настаивали на использовании статической проверки - это гораздо умнее - Alex B.(12.11.2010 15:04, ссылка)
        
        тесты, и только автоматические тесты можно считать стоящей проверкой. - bialix(15.11.2010 12:24)
        
        Вы выкладывали несколько старый, но рабочий релиз этой замечательной штуковины. Она используется частью программеров у нас (остальных недодавил). - Evgeny_CD(12.11.2010 16:06 - 16:11)
        
        static analysys - good(12.11.2010 15:20, )
        
        Это ошибка в Windows. В Unix данной ошибки не возникает. - fk0(12.11.2010 12:18)
        
        :>>>> - Snaky(12.11.2010 12:19)
        
        Не всегда. Неправильно оформленный комментарий может сломать программу. - Ruslan(10.11.2010 14:13, ссылка)
        
        А нечего в комментах фигню писать, и будет усе кучеряво...... - mazur(10.11.2010 14:24)
        
        т.е. мурку - можно, а фигню - нечего? - Snaky(10.11.2010 14:27)
        
        Ептыть, ну ясен же пень, что мурка-это образно. Комменты должны кратки, лаконичны, но емки. Иначе и действительно, комменты засоряют полезную информацию (код). В основном, комментов у меня вообще нет. Только в самых важных местах. - mazur(10.11.2010 14:31)
        
        А тост, должен быть коротким как выстрел :) Скрипач(115 знак., 12.11.2010 13:03)
        
        шутка. компилятор не видит комментов - их откусывает препроцессор - Snaky(10.11.2010 14:12)
- +2. И вообще не надо много думать о коде. Есть ещё и алгоритмы. Просто говнокодить не нужно. - fk0(02.11.2010 11:13)
- +1, особенно если гора комментов написанных "под doxygen". иногда хочется отделить мух от котлет (i.e. разнести код и комменты по разным файлам). - Snaky(02.11.2010 04:38)
  - просто надо уметь их готовить - index.html(12.11.2010 03:00, )
    - ну так покажи как, она~~нист~~ним - Alex B.(12.11.2010 11:30)

Средства и методы разработки