Spezielle HTML -Zeichen in PHPDocumentor in der Netbeans -IDE

StackOverflow https://stackoverflow.com/questions/2247082

Frage

Wie Sie wissen, werden Sie die Netbeans -IDE in den Inline -Dokumentation in Ihren PHP -Quellen basieren, die auf der PHPDocumentor -Syntax basieren.

Was ich herausgefunden habe, ist, dass wenn ich spezielle HTML -Zeichen in meiner Phpdocumentor -Dokumentation verwende, sie in NetBeans als HTML behandelt werden, aber als Text im HTML -DOC, das von PHPDocumentor erzeugt wird.

Zum Beispiel:

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

In der von PHPDocumentor erzeugten HTML wird angezeigt als:

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

Aber in der Netbeans -IDE wird es als:

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

Welcher ist richtig? Wie können spezielle HTML -Zeichen in Ihre Phpdocumentor -Kommentare einbetten?

War es hilfreich?

Lösung 3

Nach einiger Wiederholung scheint es, dass PhpDocumentor/Netbeans interpretieren muss etwasStichworte. Wie Sie auf Wikipedia sehen können hier, Nur die folgenden Tags sollten als HTML interpretiert werden:

  • b
  • Code
  • Br
  • ich
  • KBD
  • li
  • ol
  • p
  • Vor
  • Samp
  • ul
  • var

Alle anderen Tags sollten als einfacher Text angezeigt werden. Derzeit interpretieren NetBeans alle Stichworte. Dies ist ein Fehler imo, da PhpDocumentor DocBuilder nur einige Tags interpretiert.

Ich habe ein Problem eröffnet (180636) auf der Netbeans -Website.

Hoffentlich wird es bald repariert ...

Andere Tipps

Ich hätte gedacht, dass PhpDocumentor sicher per Definition richtig ist? Es ist doch ihr Format.

Es scheint ziemlich unerwünscht, in dieser Phase einen HTML-Dekode zu machen; Die gesamte Idee von Text-Markup-Systemen wie dieser besteht darin, HTML-Details wie Entity-Referenz zu vermeiden. Was passiert mit einem buchstäblichen HTML, den Sie eingeben? Versucht Netbeans, es zu rendern?

Der richtige Weg, um irgendetwas zu tun, wenn es darum geht, Sonderzeichen zu behandeln, besteht darin, die gewünschten Charaktere zu verwenden und sie im Moment zu konvertieren.

Daher ist die richtige Art und Weise, tatsächliche <> & Zeichen in Ihren Kommentaren zu verwenden, und das phpdoc -Addon muss sie in die HTML -codierten Versionen für die .html -Dateien konvertieren, wenn es dies nicht tut, dann sind es sie, die trotz des Unrecht falsch sind, trotz dessen falsch Was sie tun oder sagen.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top