вторник, 10 апреля 2012 г.

PHP - Используй php doc комментарии в коде

Используй php doc комментарии в коде. Это просто и понятно, современные IDE хорошо поддерживают такие комментарии из коробки.

Например:
 /**
  * Этот метод отвечает на главный вопрос, который задает себе человек, когда теряет память.
  *
  * @return string Ответ в произвольной форме в именительном падеже
  */
 function whoAmI()
 {
     <...>
 }

Популярные теги: 
@param
@return
@author
@todo
@property
@method
@link
@see
@version
@deprecated

Используйте @author - у всех свой почерк, но иногда реально трудно определить кто писал какой-либо метод

Ставьте пометки на будущее  @todo, например:
@todo Добавить проверку на тип