Почему точки в PHPDoc вырезали остальную часть описания?

Question

Я пытаюсь написать описание PHPDoc, и как только я набираю точку (.), Он просто обрезает остальную часть описания в помощнике по коду.Например,

/**
 * A boolean value indicating whether code assitant worked with dots in PHPDoc.
 * As you can see, it did not work!
 * @var bool
 */
public $var = false;

Я вижу только первую строку в помощнике по коду.Как бы я решил эту проблему?

Answer 1

Мне не повезло с использованием краткого описания и длинного описания в Eclipse (Helios) - даже при том, что оно должно поддерживаться.

Опция, если вы хотите увеличить длину вашего краткого описания, этоиспользовать тег
.Пока вы не включите точку в свое краткое описание, вы можете разбить его на несколько строк.Вы даже можете использовать другие теги для добавления списка маркеров, если хотите.

/**
 * Function to take a 10 digit phone number and<br>
 * return it in North American standard format of:<br>
 * <ul><li>(123) 456-7890</li></ul>
 * 
 * @param int $phone <ul><li>up to 10 digit int for the phone number</li></ul>
 * @return string <ul><li>formatted phone number</li></ul>
 */

Eclipse Helios поддерживает большинство (если не все) тегов формата DocBlock, перечисленных на этой веб-странице.
Учебник по phpDocumentor: DocBlock Описание Подробности

Однако не все эти теги работают во всех случаях, и в других разделах этой страницы есть примеры, которые НЕ работают.Но использование этих методов определенно может сделать ваши блоки phpDoc лучше.

Answer 2

Я обнаружил, что вы можете отобразить несколько предложений, если после точки поставить символ пробела в кодировке HTML (" ") Например:

/**
 * Sentence One. Sentence Two.
 */

Однако, если вы хотите включить разрывы строк в свой комментарий PHPDoc, чтобы было легче читать из исходного кода, он допустит до трех строк. Если вы включите больше, будет отображаться только первая строка. Это имеет полный смысл, потому что вам никогда не понадобится больше трех строк. Например:

/**
 * Line one. 
 * Line two.  Another line two sentence. 
 * Line three. 
 * This fourth line being here will prevent lines 2, 3, and 4, from being displayed.
 */

Спасибо за размещение этого вопроса. Мне было интересно, если я установил PDE неправильно или что-то.

Answer 3

Ашназг почти прав.Обычно есть «краткое резюме».После этого у вас не будет пустой строки, поэтому предполагается, что весь блок (включая теги) принадлежит сводке и вырубается после первого полного останова (потому что это short summary;))

Новые строки после краткого резюме и до того, как теги должны работать.

/**
 * A boolean value indicating whether code assitant worked with dots in PHPDoc.
 *
 * Should work ;)
 *
 * @var bool
 */
public $var = false;

Answer 4

Вполне вероятно, что логика помощника по коду ожидает, что описания докблока существуют в «сводном описании из одного предложения, за которым следует более подробное описание», и, скорее всего, сводное описание отображается только во всплывающих окнах.В Eclipse вы можете перейти во всплывающее окно «Помощник по коду», и информация в нем расширяется, чтобы показать все (с помощью полос прокрутки).

ОБНОВЛЕНИЕ: Тестирование точного макета KingCrunch (краткое описание периода, пустое, дополнительноеописание с / без точки, пустая строка, теги) в Eclipse PDT на Helios показывает, что точка в первом предложении действительно не позволяет всплывающему окну показывать какое-либо описание за пределами периода.Я даже переместил вторичную часть в ту же строку с первой частью, и все, что находится за пределами периода, все еще не появляется.Измените его на запятую, и тогда появится все до следующего периода.Ну, если нет пустой строки между запятой и следующей строкой ... в этом случае пустая строка имеет тот же эффект, что и точка, блокируя все после нее.Я не вижу проблем с отображением и интерпретацией тегов, независимо от того, являются ли фрагменты описания видимыми.

Поэтому я считаю, что Eclipse действительно игнорирует все описания, кроме первого периода и / или пустой строки.что он сталкивается.Я не знаю, как отключить это поведение.