Комментарии 12
со своей "колокольни" могу сказать, что комментарии в коде если и нужны, то только, как пояснение каких-то хаков, без которых не обойтись
подавляющую массу кода можно сделать самодокументируемой путем рефакторинга
читая чужой код я всегда мечтаю о внешней документации по коду, не о комментариях, поскольку дерево файлов проекта обычно плохо раскрывает макроархитектуру программы
в свое время мне нравились такие вещи, как Doxygen
подавляющую массу кода можно сделать самодокументируемой путем рефакторинга
читая чужой код я всегда мечтаю о внешней документации по коду, не о комментариях, поскольку дерево файлов проекта обычно плохо раскрывает макроархитектуру программы
в свое время мне нравились такие вещи, как Doxygen
Я за Калликла! Крайне предпочтительно создавать код не нуждающийся в комментариях. Давать «говорящие» имена классам, методам и переменным. А комментариями снабжать только крайне неочевидные фрагменты кода, когда стремясь за производительностью либо какими другими целями приходится отступать от принципа очевидности кода.
Первое, что хотелось написать - Ниасилил!
Сдержался, да. С трудом. :-)
1. Притча, как и программный метод, должна быть недлинной. Строк 20-30. Ну ладно - для эстетов - 40-50 :-)
2. Имена действующих лиц, как и названия переменных, не заумными, а понятными нашему человеку. Ну скажем так:
ФРАСИМАХ = Салага.
КАЛЛИКЛ = ОпытныйПерец.
ГЛАВКОН = Выскочка.
ИСМЕНА = ПрикладнаяТётка.
СОКРАТ = МудрыйПряник.
ну и так далее...
3. Комментарии бывают тактические и стратегические.
Тактические, могут быть скомпенсированы грамотными названиями методов и переменных. Нужны в непростых местах (типа сдвига третьего бита влево на 17 позиций, какого хрена...).
Стратегические - желательны всегда. Для чего это всё нужно, какой алгоритм, подход, патерны запользованы. Хотя бы несколько строк на метод.
ну где-то во-так видимо....
Сдержался, да. С трудом. :-)
1. Притча, как и программный метод, должна быть недлинной. Строк 20-30. Ну ладно - для эстетов - 40-50 :-)
2. Имена действующих лиц, как и названия переменных, не заумными, а понятными нашему человеку. Ну скажем так:
ФРАСИМАХ = Салага.
КАЛЛИКЛ = ОпытныйПерец.
ГЛАВКОН = Выскочка.
ИСМЕНА = ПрикладнаяТётка.
СОКРАТ = МудрыйПряник.
ну и так далее...
3. Комментарии бывают тактические и стратегические.
Тактические, могут быть скомпенсированы грамотными названиями методов и переменных. Нужны в непростых местах (типа сдвига третьего бита влево на 17 позиций, какого хрена...).
Стратегические - желательны всегда. Для чего это всё нужно, какой алгоритм, подход, патерны запользованы. Хотя бы несколько строк на метод.
ну где-то во-так видимо....
комментарии нужны, комментарии важны! (:
Не то что бы краткость всегда является сестрой таланта, но в вашем случае стоит задуматься.
Помнится изначально у вас было желание типа выкладывать короткие выжимки из СС. А теперь получается вы пишете, "разливаясь по древу", еще больше чем в СС.
Это не выжимки а наоборот раздувание. Такими темпами СС из 900 страничного талмуда превратится в 9000ный ...
Имхо еще стоит задуматься о стиле изложения. Диалоги это конечно забавно, но не в технической статье, хорошо еще что у вас компилятор с IDE не разговаривают, такой бы сюрр был...
Помнится изначально у вас было желание типа выкладывать короткие выжимки из СС. А теперь получается вы пишете, "разливаясь по древу", еще больше чем в СС.
Это не выжимки а наоборот раздувание. Такими темпами СС из 900 страничного талмуда превратится в 9000ный ...
Имхо еще стоит задуматься о стиле изложения. Диалоги это конечно забавно, но не в технической статье, хорошо еще что у вас компилятор с IDE не разговаривают, такой бы сюрр был...
Небольшой пардон - это выдержка из самого Макконела =). Отписал комментарий и решил листануть СС - я этот кусок в свое время пропустил, именно потому что посчитал бредовым.
В общем суть мнения от этого не меняется - имхо если хотите донести СС до тех кто не осилил оригинал - пишите выжимки идей, вряд ли кто захочет осиливать это на хабре пусть даже и перепечатанное.
А вообще по-моему неблагодарное это дело, "каждый программист должен сам прийти к этой книге" ;)
В общем суть мнения от этого не меняется - имхо если хотите донести СС до тех кто не осилил оригинал - пишите выжимки идей, вряд ли кто захочет осиливать это на хабре пусть даже и перепечатанное.
А вообще по-моему неблагодарное это дело, "каждый программист должен сам прийти к этой книге" ;)
Следующим шагом хочу выложить именно тезисы (их будет много) об архитектуре. Насчет стиля - хочу понять, какой народу ближе всего.
А оно надо ? Просто имхо вы пытаетесь людям объяснить на пальцах то, к чему надоидти практикой. Вот если бы мне начали 3 года назад рассказывать макконела - я бы сказал - интересно но много и мутно. Теперь же я понимаю то, ПОЧЕМУ надо делать как он пишет, а не КАК надо делать.
Знание КАК без ПОЧЕМУ - не имеет смысла, потому что оно или забывается, или воспитывается "культ Карго" (погуглите, если интересно). А ПОЧЕМУ объяснить нельзя, к этому надо прийти. Я тоже думал что можно учиться на теории и чужих ошибках. Проблема в том, что чужие ошибки не запоминаются. А вот свои - еще как.
Знание КАК без ПОЧЕМУ - не имеет смысла, потому что оно или забывается, или воспитывается "культ Карго" (погуглите, если интересно). А ПОЧЕМУ объяснить нельзя, к этому надо прийти. Я тоже думал что можно учиться на теории и чужих ошибках. Проблема в том, что чужие ошибки не запоминаются. А вот свои - еще как.
Ваш опыт - это не опыт других людей.
У меня лично есть несколько знакомых, которые не берутся читать эту книгу из-за объема. Если она будет изложена в тезисах - им будет легче. Уверен, таких немало.
У меня лично есть несколько знакомых, которые не берутся читать эту книгу из-за объема. Если она будет изложена в тезисах - им будет легче. Уверен, таких немало.
Эти тезисы у людей мало отложатся.
Хотите расскажу как я ее прочитал ( подразумевается ответ - да =) ):
Я СС читал в общей сумме наверное 1.5 года. Сначала эта книжка лежала у меня на тумбочке, мозолила глаза. Месяца 3 лежала, надоело. Потом я привез ее домой, положил в неудобное место, она там мешалась еще месяца 2. Будучи в хреновом настроении, я ее открыл, прочитал начало, и закрыл. Переложил на удобное, но видное место, т.е. она не мешала но мозолили глаза. Начал читать понемногу и параллельно с этим серьезно "увяз" в новом проекте, и стал пытаться на практике применять прочитанное. Потихоньку, глядя на результаты проекта - начал читать все внимательней, подмечать нюансы, акцентировать внимание на том, что я сделал не так, как написано, и почему я это сделал не так (не только от незнания). А книга мне помогала разъяснять - почему так делать не стоит Вот так и осилил.
Важен первый шаг, как говорят - главное начать.
Хотите расскажу как я ее прочитал ( подразумевается ответ - да =) ):
Я СС читал в общей сумме наверное 1.5 года. Сначала эта книжка лежала у меня на тумбочке, мозолила глаза. Месяца 3 лежала, надоело. Потом я привез ее домой, положил в неудобное место, она там мешалась еще месяца 2. Будучи в хреновом настроении, я ее открыл, прочитал начало, и закрыл. Переложил на удобное, но видное место, т.е. она не мешала но мозолили глаза. Начал читать понемногу и параллельно с этим серьезно "увяз" в новом проекте, и стал пытаться на практике применять прочитанное. Потихоньку, глядя на результаты проекта - начал читать все внимательней, подмечать нюансы, акцентировать внимание на том, что я сделал не так, как написано, и почему я это сделал не так (не только от незнания). А книга мне помогала разъяснять - почему так делать не стоит Вот так и осилил.
Важен первый шаг, как говорят - главное начать.
Статья хорошая. Но с абзацами и разделением реплик что не то. Читается с трудом.
потдерживаю Steamus и kivsiak!
ей богу переписали бы по человечески, на самом деле если напрячься можно понять, что хорошая и полезная статья, но нечитаемые имена (и не совпадаюшие в начальном описании и тексте ИСМЕНА!=Йемена), сваленый в кучу текст и т.п. убивают всякое желание читать
ей богу переписали бы по человечески, на самом деле если напрячься можно понять, что хорошая и полезная статья, но нечитаемые имена (и не совпадаюшие в начальном описании и тексте ИСМЕНА!=Йемена), сваленый в кучу текст и т.п. убивают всякое желание читать
Зарегистрируйтесь на Хабре, чтобы оставить комментарий
Комментировать или не комментировать?