Ответ
Misha v.3 30.08.2006 13:04
Похоже я неправильно вас понял. Вы про встроенную документацию или про последний совет?
последний совет по моему вообще не имеет права на существавание :)
про встроеную документацию - сокращать. берем пример документации файла/класса и видим:
@copyright, @license, @version, @since
беру стандартный CVS-ный id:
# $Id: dtf.p,v 1.22 2005/11/02 15:51:29 misha Exp $
и возникает вопрос: на фига столько избыточных букв? или зачем '##' вместо '#'?
беру пример документации метода и сразу возникает желание выкинуть описание входящих параметров. название метода + названия input variables должны говорить сами за себя (+ описывать типы при наличии префиксов незачем)
P.S. ваш пример:
$newVarString[] # Вроде строка
- некорректен. символ '#' используется для комментирования только в случае, если он первый в строке => незачем в стандарте писать что код не должен содержать ошибок :)
