Форум Flasher.ru
Ближайшие курсы в Школе RealTime
Список интенсивных курсов: [см.]  
  
Специальные предложения: [см.]  
  
 
Регистрация Блоги Правила Справка Пользователи Календарь Поиск рулит! Сообщения за день Все разделы прочитаны
 

Вернуться   Форум Flasher.ru > Блоги > FriOne

Оценить эту запись

Комментирование.. какое оно?

Запись от FriOne размещена 19.08.2010 в 02:36

Недавно посмотрел как описан код классов у TweenLite, после залез в свой код и ужаснулся разнице, например понравилось выделение блоков:
Код AS1/AS2:
/**
* 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.
*/
Посмотрел, видно верх с заголоком и низ, создается впечатление как буд-то папка со вложенным в нее нутром. Или простое вот:
Код AS1/AS2:
//ignore
 
/** @inheritDoc **/
И другие более подробные описания на английском, сильно не вчитывался..)

Стало интересно как комментарят другие пользователи свой код и что они описывают в них, как они делают свой код более понятным и удобно писаемым))..
Опишите свои комментарии кода, если надется минутка, плз..

P.S.Опытные пользователи приветсвуются)
Всего комментариев 28

Комментарии

Старый 19.08.2010 13:50 udaaff вне форума
udaaff
Старый 19.08.2010 14:20 -De- вне форума
-De-
 
Аватар для -De-
это для автогенерации документации (ASDoc) используется
Старый 19.08.2010 14:49 Psycho Tiger вне форума
Psycho Tiger
 
Аватар для Psycho Tiger
Комментирую паблик и протектед методы в классах, которые скорее всего буду использовать позже. В своём фреймворке стараюсь комментировать каждый метод, в т.ч. и приватный.

П.С.: привет земляк)
Старый 19.08.2010 15:19 FriOne вне форума
FriOne
 
Аватар для FriOne
Ха) крутая штука, с моим английским не все понимаю..
Все, что внутри блока, если я правильно понял, реализуется какой-то утилитой?
P.S. "Do this:" хотел бы тоже такую комментировалку сделать..

http://opensource.adobe.com/wiki/dis.../ASDoc+in+MXML
Нашел только вот, на AS2 реализуемо?

to Psycho Tiger: Здарова!!)
До вчера комментировал только ненужные мне блоки)
Буду каждую сточку комментить, чтобы описание было похожим на текст из дока)
Старый 19.08.2010 16:26 Psycho Tiger вне форума
Psycho Tiger
 
Аватар для Psycho Tiger
Нене, каждую строчку ненадо. Комментировать нужно системные вещи, какие то общие участки, типа //Здесь идём внутрь графа с целью поиска значения n, и public, internal и protected методы.
Например, во FlashDevelop`е ASDoc всплывает, если напечатать /**
Старый 19.08.2010 16:55 Котяра вне форума
Котяра
 
Аватар для Котяра
Каждую строчку - это перебор.
Достаточно писать хорошо читабельный код и описывать asdoc теги/
в неочевидных местах кода - комментируй.
У Макконнелла хорошо описано про комменты.
asdoc на as2 - реализуем в FD.
Только это должен быть действительно AS2, а не AS1.
Обновил(-а) Котяра 19.08.2010 в 16:59
Старый 19.08.2010 19:00 FriOne вне форума
FriOne
 
Аватар для FriOne
Сейчас первый раз делаю небольшой сайт-визитку.. использую только функции (без ООП(исключая мувиклипы и т.д.))
Комменты.. например начало блока кода:
Код AS1/AS2:
//*************
//////КНОПКИ//////
//************
Потом черз несколько блоков(например загрузка картинок, меню и т.д.) смотришь:
Код AS1/AS2:
//***************************************
/////////КНОПКИ УПРАВЛЕНИЯ КАРТИНОК////////////
//**************************************
И комментарии из-за этого не дают того, для чего они придуманы)
Если использовать на сайте больше ООП, легче же ориентироваться в коде?
Давно хотел начать, почему-то с трудом дается понимание, вроде все поянтно все пройдено на учебе..
Старый 19.08.2010 19:27 Psycho Tiger вне форума
Psycho Tiger
 
Аватар для Psycho Tiger
Без ООП вообще очень тяжело.

Если пишешь без ООП - значит, ты пишешь на AS1, поэтому да, у тебя функции, а не методы.
Поначалу мне тоже было тяжело абстрагироваться от _root и каких то контейнеров, в которые можно писать много разных переменных (тот же _root в AS1). Теперь убью автора кода, если мне придётся работать с ним.
Старый 02.04.2011 19:33 Gaen вне форума
Gaen
 
Аватар для Gaen
http://paste.org.ru/?5usx3h
Пишу коммент для каждого метода.
Разделяю секции public/private/protected свойств/методов.
Внутри секции разделяю методы по функционалу - проще ориентироваться, плюс если класс разрастется, то сразу будет ясно, что можно вынести.
Комментирую закрывающие скобки - один раз где-то увидел, и теперь жить без этого не могу.
Табуляцией выстраиваю правую часть всех объявлений и присвоений внутри блока на одном уровне - взгляд цепляется моментально.
Старый 02.04.2011 19:55 iNils вне форума
iNils
 
Аватар для iNils
Цитата:
Комментирую закрывающие скобки - один раз где-то увидел, и теперь жить без этого не могу.
А смысл? В нормальных редакторах есть подсветка парной скобки.
Старый 03.04.2011 01:10 i.o. вне форума
i.o.
 
Аватар для i.o.
Цитата:
один раз где-то увидел
подозреваю, что вы увидели тогда декомпилированный код... ыыы
Старый 03.04.2011 01:32 iNils вне форума
iNils
 
Аватар для iNils
Цитата:
подозреваю, что вы увидели тогда декомпилированный код
Вполне возможно, но в начале 90-х, когда я только начинал программировать на бейсике, часто встречал код, который комментировал закрывающие операторы, типа if... end if
Старый 03.04.2011 11:01 dimarik вне форума
dimarik
 
Аватар для dimarik
GAIKER, приятно читать Ваш код.
Старый 03.04.2011 12:25 CrazyFlasher вне форума
CrazyFlasher
 
Аватар для CrazyFlasher
комментю только исключительно либы (и то нехотя).
И никогда не читаю комменты. Для этого должна быт документация. А методы в коде должны в названии отражать суть. Зачем разжовывать... Если без комментов не понять, значит код *****..имхо
Старый 03.04.2011 14:40 GBee вне форума
GBee
 
Аватар для GBee
Солидарен с CrazyFlasher. :о)
Старый 03.04.2011 15:14 etc вне форума
etc
 
Аватар для etc
Не пишу комментарии к понятному коду, т. е. в 99% случаев.
Старый 03.04.2011 16:51 f.g.programmer вне форума
f.g.programmer
 
Аватар для f.g.programmer
Понятность кода очень субъективна. Мне мой код тоже понятен на 99%
Старый 03.04.2011 17:35 etc вне форума
etc
 
Аватар для etc
Я вот не вижу смысла писать комментарий «инициализация» к методу init, как это делает GAIKER.
Старый 03.04.2011 17:42 iNils вне форума
iNils
 
Аватар для iNils
Цитата:
Понятность кода очень субъективна.
Соглашусь. В отличии от димарика, мне данный код читать было трудно.
Старый 03.04.2011 19:04 i.o. вне форума
i.o.
 
Аватар для i.o.
GAIKER, а там специально двойные переносы или это сайт так отображает?
Старый 03.04.2011 23:09 mayakwd вне форума
mayakwd
 
Аватар для mayakwd
Рекомендую к прочтению
В книжке очень много умных мыслей на тему.
Старый 04.04.2011 15:49 easy.proger вне форума
easy.proger
О начинается "с мое" и т/д/ )) запасаюсь попкорном ^^*

по теме - код должен быть понятным )
Старый 04.04.2011 18:07 Rzer вне форума
Rzer
 
Аватар для Rzer
Ещё у GAIKER'а this везде стоит. Может быть это и правильно, но требуется лишнее время на понимание того, что написано. Я ставлю this только когда присваиваю приватной переменной значение из аргумента, например:

Код AS3:
private var service:ServiceCollection;
 
public function attachService(service:ServiceCollection):void{
   this.service = service;
}
Старый 04.04.2011 18:58 Zebestov вне форума
Zebestov
 
Аватар для Zebestov
Писал this и super везде. И смотрелось неплохо, и читалось легко. И кошерно вроде )
А потом начал новый проект и так ясно вдруг осознал: задолбало!!! Так что сейчас нифига никаких this и super без надобности!
Старый 04.04.2011 19:09 Psycho Tiger вне форума
Psycho Tiger
 
Аватар для Psycho Tiger
А мне без super одиноко.
Старый 04.04.2011 22:17 etc вне форума
etc
 
Аватар для etc
Zebestov, ага, ровно пока не смешаются в кучи локальные переменные, поля и статики.
Старый 04.04.2011 22:29 iNils вне форума
iNils
 
Аватар для iNils
Вы как-то от обсуждения комментирования ушли.
Старый 04.04.2011 22:47 Zebestov вне форума
Zebestov
 
Аватар для Zebestov
etc, до такой каши у меня еще не доходило. Ну а дойдет — это и будет тот самый случай "надобности".
iNils, согласен.
По теме: всегда комментирую участки, работу которых можно ясно представить лишь попрыгав по проекту, например. Ну и я наверное еще совсем нуб, но я экономлю нимало времени, когда читаю камент на русском вместо кода на AS3.
 
Последние записи от FriOne

 


Часовой пояс GMT +4, время: 06:54.


Copyright © 1999-2008 Flasher.ru. All rights reserved.
Работает на vBulletin®. Copyright ©2000 - 2018, Jelsoft Enterprises Ltd. Перевод: zCarot
Администрация сайта не несёт ответственности за любую предоставленную посетителями информацию. Подробнее см. Правила.