Как задокументировать переменную в phpDocumentator ?

[Astral Man]

Как задокументировать переменную в phpDocumentator ?

Собственно сабж.

 

[Frol]

какой смысл несет великое слово "задокументировать"?

 

[Astral Man]

Автор оригинала: Frol
какой смысл несет великое слово "задокументировать"?

Внести в документацию описание этой переменной.

 

[Panchous]

Astral Man
Ну если ты "задокументировал" все остальное - думаю можно и об этом догадаться)

 

[Astral Man]

Panchous
Документируется все, функции, классы, константы... а вот переменные не получается, с помощью какого параметра это делается?

 

[Panchous]

см. здесь

 

[Astral Man]

Panchous
Ню-ню
Что написано "Document the data type of a class variable" ?
Это для переменной класса, а мне нужно самую обычню переменную включить в документацию, типа такой

$my_var = 'blahblah'

 

[Panchous]

а зачем?

 

[Astral Man]

Panchous
Надо знать каке переменные используются, и что могут или уже содержат.

 

[Panchous]

@global?
а другие переменные, насколько я знаю, не документируются)

Приведи пример переменной (с контекстом), которая нуждается в ДОКУМЕНТАЦИИ (всегда остаются комментарии)

 

[Astral Man]

Panchous
Файл конфигурации, нужно описать все переменный которые используются для настройки системы

 

[Panchous]

Файл конфигурации

а что он собой представляет?

если это не INI-файл, то используй глобальные переменные и вышеуказанную ссылку

 

[Astral Man]

Panchous
Нет это не INI файл, глобальные переменные мне использовать не надо, тем более это полохой тон.
Нужно просто их описать...

 

[Panchous]

глобальные переменные мне использовать не надо, тем более это полохой тон

а зачем тогда они нужны?

если это настройки - разве их не должны видеть?

 

[Astral Man]

Panchous
Их и так видно, если этот файл подключить в главном файле.
Вопрос не в этом видно, или нет... а в другом...