Комментирование.. какое оно?
Запись от FriOne размещена 19.08.2010 в 02:36
Недавно посмотрел как описан код классов у TweenLite, после залез в свой код и ужаснулся разнице, например понравилось выделение блоков:
/**
* Constructor
*
* @param target Target object whose properties this tween affects. This can be ANY object, not just a MovieClip.
* @param duration Duration in seconds (or in frames if the tween's timing mode is frames-based)
* @param vars An object containing the end values of the properties you're tweening. For example, to tween to _x=100, _y=100, you could pass {_x:100, _y:100}. It can also contain special properties like "onComplete", "ease", "delay", etc.
*/
И другие более подробные описания на английском, сильно не вчитывался..)
Стало интересно как комментарят другие пользователи свой код и что они описывают в них, как они делают свой код более понятным и удобно писаемым))..
Опишите свои комментарии кода, если надется минутка, плз..
P.S.Опытные пользователи приветсвуются)
Всего комментариев 28
Комментарии
![]() ![]() |
|
![]() ![]() |
|
это для автогенерации документации (ASDoc) используется
|
![]() ![]() |
|
Ха) крутая штука, с моим английским не все понимаю..
Все, что внутри блока, если я правильно понял, реализуется какой-то утилитой? P.S. "Do this:" хотел бы тоже такую комментировалку сделать.. http://opensource.adobe.com/wiki/dis.../ASDoc+in+MXML Нашел только вот, на AS2 реализуемо? to Psycho Tiger: Здарова!!) До вчера комментировал только ненужные мне блоки) Буду каждую сточку комментить, чтобы описание было похожим на текст из дока) |
![]() ![]() |
|
Каждую строчку - это перебор.
Достаточно писать в неочевидных местах кода - комментируй. У Макконнелла хорошо описано про комменты. asdoc на as2 - реализуем в FD. Только это должен быть действительно AS2, а не AS1. |
|
Обновил(-а) Котяра 19.08.2010 в 16:59
|
![]() ![]() |
|
http://paste.org.ru/?5usx3h
Пишу коммент для каждого метода. Разделяю секции public/private/protected свойств/методов. Внутри секции разделяю методы по функционалу - проще ориентироваться, плюс если класс разрастется, то сразу будет ясно, что можно вынести. Комментирую закрывающие скобки - один раз где-то увидел, и теперь жить без этого не могу. Табуляцией выстраиваю правую часть всех объявлений и присвоений внутри блока на одном уровне - взгляд цепляется моментально. |
![]() ![]() |
|
Цитата:
Комментирую закрывающие скобки - один раз где-то увидел, и теперь жить без этого не могу.
|
![]() ![]() |
|
Цитата:
один раз где-то увидел
![]() |
![]() ![]() |
|
GAIKER, приятно читать Ваш код.
|
![]() ![]() |
|
Солидарен с CrazyFlasher. :о)
|
![]() ![]() |
|
Не пишу комментарии к понятному коду, т. е. в 99% случаев.
|
![]() ![]() |
|
Понятность кода очень субъективна. Мне мой код тоже понятен на 99%
![]() |
![]() ![]() |
|
Я вот не вижу смысла писать комментарий «инициализация» к методу init, как это делает GAIKER.
|
![]() ![]() |
|
Цитата:
Понятность кода очень субъективна.
|
![]() ![]() |
|
GAIKER, а там специально двойные переносы или это сайт так отображает?
|
![]() ![]() |
|
Рекомендую к прочтению
В книжке очень много умных мыслей на тему. |
![]() ![]() |
|
О начинается "с мое" и т/д/ )) запасаюсь попкорном ^^*
по теме - код должен быть понятным ) |
![]() ![]() |
|
А мне без super одиноко.
|
![]() ![]() |
|
Zebestov, ага, ровно пока не смешаются в кучи локальные переменные, поля и статики.
|
![]() ![]() |
|
Вы как-то от обсуждения комментирования ушли.
|
Последние записи от FriOne
- Комментирование.. какое оно? (19.08.2010)