Специальные символы HTML в phpDocumentor в IDE NetBeans - PullRequest
Новая
       28

Специальные символы HTML в phpDocumentor в IDE NetBeans

0 голосов
/ 11 февраля 2010

Как вы знаете, среда IDE NetBeans отобразит встроенную документацию в ваших источниках PHP на основе синтаксиса phpDocumentor.

Что я обнаружил, так это то, что когда я использую специальные символы HTML в моей документации phpDocumentor, они рассматриваются как HTML в NetBeans, но как текст в документе HTMl, сгенерированный phpDocumentor.

Например: 

/**
 * Add a new <link> to the <head> of the document.
 */

В HTML, сгенерированном phpDocumentor, будет отображаться как: 

Add a new <link> to the <head> of the document.

Но в IDE NetBeans он будет отображаться как: 

Add a new <link> to the <head> of the document.

Какой из них прав? Как правильно встраивать специальные HTML-символы в комментарии phpDocumentor?

Ответы [ 3 ]

0 голосов
/ 12 февраля 2010

Что ж, правильный способ сделать что-либо в отношении обработки специальных символов - это использовать нужные символы и преобразовывать их в тот момент, когда вам нужно.

Поэтому правильный путь - использовать действительные символы <> & в ваших комментариях, а аддон phpDoc должен преобразовать их в версии в кодировке HTML для файлов .HTML, если этого не происходит, то именно они неправильно, несмотря на то, что они делают или говорят.

0 голосов
/ 09 марта 2010

После некоторого исследования кажется, что phpDocumentor / NetBeans должен интерпретировать некоторые теги. Как вы можете видеть в Википедии здесь , только Следующие теги должны интерпретироваться как HTML:

  • б
  • код
  • ш
  • я
  • KBD
  • Li
  • ол
  • до
  • сэмпл
  • уль
  • вар

Все остальные теги должны отображаться в виде простого текста. В настоящее время NetBeans интерпретирует все теги. Это ошибка IMO, так как phpDocumentor docBuilder интерпретирует только некоторые теги.

Я открыл проблему ( 180636 ) на веб-сайте NetBeans.

Надеюсь, это будет исправлено в ближайшее время ...

0 голосов
/ 11 февраля 2010

Я бы подумал, что phpDocumentor прав по определению? Это их формат в конце концов.

На данном этапе кажется довольно нежелательным делать HTML-декодирование; вся идея подобных систем разметки текста состоит в том, чтобы избежать деталей HTML, таких как экранирование ссылки на сущность. Что происходит с любым введенным вами буквенным HTML-кодом, пытается ли NetBeans его отобразить?

...