Как документировать закрытие с помощью phpdocumentor?

Question

Итак, я работаю с микрофреймом Silex, и мне интересно, как правильно PHPDoc задокументировать закрытие.

Как документировать закрытие GET?

Answer 1

Что вы хотите сказать читателю своего документа в отношении этого закрытия? Вы хотите подчеркнуть, что он существует, или создать ссылку @uses < -> @ usedby на метод Silex \ Application-> escape(), который используется вашим закрытием?

Я не знаю, что существует какой-либо синтаксис PHPDoc для документирования закрытия (пока), но при условии, что он фактически не может использоваться потребителем в контексте API, я не уверен, что есть прецедент для использования документируйте это ... ну, кроме предоставления подробностей читателю для чтения кода. Если это так, я бы, вероятно, использовал тег @internal для записи любых заметок о закрытии, которые я хотел, чтобы читатель знал об этом. Кроме того, учитывая, что я не вижу «документальных элементов» в этом фрагменте кода, вам придется поместить этот тег @internal в док-блок уровня файла.