NetBeans phpdoc / форматирование комментариев - PullRequest
2 голосов
/ 28 ноября 2010

где я могу изменить это глупое форматирование, я смотрю на все варианты в редакторе / формате, но не нашел ничего полезного! Когда я только что написал блок комментариев: alt text

и когда я нажимаю SHIFT + ALT + F или источник / формат в блоке комментариев меню, происходит сбой, и вся красота комментария phpDoc разрушается: (

alt text

1 Ответ

4 голосов
/ 05 декабря 2010

Поскольку вы пытаетесь поместить блок phpDoc в середину кода, я считаю, что NetBeans дает вам некоторую комбинацию Начальный отступ и Продолжение отступа (можно найти в разделе Инструменты | Параметры | Редактор | Форматирование, где язык = PHP и категория = вкладки и отступы).

Настоящая проблема в том, что комментарии docblock не найдены в потоке кода. Взгляните на страницу руководства phpDocumentor на документируемых элементах . Комментарии к докблоку должны находиться в очень специфических местах, например, перед функциями, перед определениями классов, перед определениями операторов и т. Д.

В вашем случае, если предположить, что блок try-catch находится внутри функции, тогда @todo войдет в блок документов, который появляется непосредственно перед функцией.

В качестве альтернативы вы можете переключиться на стиль комментария "одна строка", например

// @todo - Fix something with the next line

но это не будет найдено в phpDoc. (На самом деле, в вашем примере с docblock в потоке кода я не уверен, что phpDocumentor также подхватит это.) Кроме того, он будет иметь отступ хотя бы на один уровень от оператора try, так как оно появляется внутри блока.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...