parser

Написать ответ на текущее сообщение

 

 
   команды управления поиском

Ответ

Kseire 30.08.2006 14:05 / 30.08.2006 14:06

про встроеную документацию - сокращать. берем пример документации файла/класса и видим:
@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[] # Вроде строка
- некорректен. символ '#' используется для комментирования только в случае, если он первый в строке => незачем в стандарте писать что код не должен содержать ошибок :)
Прошу прощения, я не программист, а всего лишь проектировщик. И насчет таких нюансов, как комментарии знал не так много. Теперь знаю.