Документирование interface в PHP проектах?

[Gremboloid]

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

 

[fixxxer]

Ага-ага.

/**
* setVar
* sets var $name to $value
*/
function setVar($name, $value)

дофига понятнее стало!

 

[Gremboloid]

Простой код влечет за собой краткое описание, не вижу ничего противоестественного.

 

[whirlwind]

Автор оригинала: Gremboloid
Простой код влечет за собой краткое описание, не вижу ничего противоестественного.

код должен быть простым

 

[Здыхлик]

А если так:
/**
* setVar
* sets var $name to $value
*
* @throws CustomException
* @return this
*/
function setVar($name, $value)

Лучше?

 

[Gremboloid]

whirlwind


Здыхлик, больше похоже на описание реализации включения интерфейса в класс

 

[Здыхлик]

Ну да. Это больше к слову о простых функциях, которые якобы не требуют комментирования

 

[FB3]

Автор оригинала: admin
Попробуй в разных файликах разместить интерфейс и имплементацию.

Дело было не в разных файликах, а в том, что я не реализовал методы интерфейса в классе, поэтому хваталось из интерфейса.
Вставил пустые методы и перестало из PHPDOC хвататься.