Tag: phpdoc

phpDocumentor (phpdoc) ist eine automatische code-Dokumentations-tool für PHP, basierend auf Javadoc.

PHPDoc-Kommentare in Notepad++?

5 Antworten

Ich habe sehr viel Freude an der Arbeit in Notepad++, aber ich habe noch nicht gefunden, ein plugin, um automatisch PHPDoc-Kommentare. Andere PHP-IDE ' s (Eclipse, NetBeans, ZendStudio) enthalten diese Funktion, und es ist ganz praktisch. Im

comments notepad++php phpdoc

PHPDoc: Typehint in verschachtelten arrays (mit z.B. 2 Dimensionen)

2 Antworten

Gibt es eine richtige Art und Weise zu dokumentieren, Werte/Objekte, die in arrays, die in einer anderen dimension? Normalerweise ein array behandelt werden wie diese: /** @var ClassName $Array */ $Array = array( $InstanceOfClassName,.. ) Aber ich

arrays code-documentation php phpdoc

Füllen @version-tag mit subversion in Eclipse

2 Antworten

Ich möchte füllen Sie das Kommentar-tag @version mit Subclipse oder Subversion in Eclipse. CVS hat sich erledigt dies automatisch, aber bei Subversion ist das nicht. Dies würde sehr hilfreich sein. Habe ich versucht zu google "@version", aber

eclipse phpdoc subclipse svn

PHPStorm: richtige PHPDoc für eine Sammlung von Objekten?

1 Antworten

Ich bin mit dem PHPStorm IDE, und führen Sie in Schwierigkeiten, wenn ich die code-Inspektion. Habe ich eine Methode, die zurückgibt, eine Sammlung von Objekten. Die Collection selbst ist ein Objekt, das seine eigenen Methoden, und implementiert

php phpdoc phpstorm

PhpDoc für Schnittstelle und Klasse die interface - Unterschied

2 Antworten

Die Frage ist ganz einfach - wie soll ich unterscheiden, phpdoc, die für die Oberfläche und für die Klasse die Schnittstelle? Kann/soll Sie gleich sein, oder vielleicht-Schnittstelle Dokumentation sollte so allgemein wie möglich und Klasse, die diese

class documentation interface php phpdoc

Verhindern xmlns="" - Attribut wird Hinzugefügt, um HTML-Elemente generiert werden durch die XSLT-1.0

2 Antworten

Ich bin in den Prozess der Erstellung einer Vorlage für phpdoc-2 und ich bin versucht, herauszufinden, wie um zu verhindern, dass das Attribut xmlns="http://www.w3.org/1999/xhtml" Hinzugefügt wird die root-Ebene Elemente des generierten HTML-Codes, wenn die Dokumentation erstellt wird,

phpdoc xml-namespaces xslt xslt-1.0

Wie soll ich PHPDoc einen Rückruf?

4 Antworten

Habe ich eine Methode, welche Ausschnitte einer modifizierten preorder tree transversal-Struktur aus der Datenbank, und Filter, die mit einer callback-Funktion. Zum Beispiel: /** * Recursive function for building the Cas_Template_TreeNode. * * @static * @param array $rows

php phpdoc

Nicht auszuschließen Verzeichnisse von PHPDocumentor

3 Antworten

Ich versuche zu laufen, PHPDocumentor auf meinem WAMPServer setup. Es läuft gut, aber ich würde gerne ausschließen bestimmter Verzeichnisse wie \sqlbuddy\, die nicht enthalten, meinen eigenen code. Ironischerweise, PHPDocumentor scheint das ignorieren meiner --ignore-Schalter. Ich habe versucht,

documentation php phpdoc

Wie zu aktualisieren und zu generieren DocBlock für das gesamte Projekt in PhpStorm?

2 Antworten

Habe ich code-Inspektion für php-doc-Blöcken, so dass ich jetzt eine Warnung erhalten, wenn Sie fehlen oder unvollständig sind. Wenn ich eine Klasse geöffnet ist, kann ich verwenden Code > Generate > PhpDocBlocks zu generieren oder starten Sie

php phpdoc phpstorm

Sollte ich @return self oder der aktuellen Klasse?

4 Antworten

Habe ich eine Methode, die das aktuelle Objekt, wie dokumentiere ich diese? /** * set something * * @return this */ public function setSomething(){ //... return $this; } Oder sollte ich @return self oder @return Current_Class_Name? Verwandte,

doc documentation php phpdoc

Phpdoc Keine Inhaltsangabe gefunden, für diese Datei

5 Antworten

Habe ich installiert phpDoc auf unserem server, Einrichtung etc. Es ist die Herstellung der Dokumentation korrekt. Wir sind mit der 'Responsive' Vorlage, aber dieser Fehler tritt unabhängig von der Vorlage verwendet. Unter den "Fehler", jede Datei gescannt

php phpdoc

PHPDoc-Dokumentation generator, der in oder aus Eclipse heraus?

3 Antworten

Ich entwickle mit Eclipse + PDT. Ich habe das hinzufügen von phpdoc-Kommentare in meinem code aber eigentlich nie erzeugt eine resultierende Dokumentation in Eclipse. Wie soll ich das machen - gibt es einige Funktionen, die in Eclipse-oder

documentation eclipse php phpdoc

PHPDocumentor 2 und PHP 7 mit opcache Probleme in der Lehre

5 Antworten

Ich hoffe, jemand hier kennt eine Sache oder 2 über diese. Kurze Frage Habe ich ein Fehler mit phpdoc auf der Kommando-Zeile installiert es über pear PHP 7.0.2. Der Fehler ist: #> phpdoc PHP Fatal error: Uncaught

opcache php php-7 phpdoc phpdocumentor2

So ändern Sie die Standard-Autor in PhpStorm für PHPDoc

5 Antworten

Suche ich für einen moment eine Art und Weise ändern Sie den Namen und E-mail verwendet, die von PHPDoc in PhpStorm, wenn Sie die "autocomplete" durch drücken der Taste Enter nach der Eingabe /** nur vor, eine

configuration phpdoc phpstorm

PHP-Funktion Kommentare

4 Antworten

Nur eine kurze Frage: ich habe gesehen, dass einige PHP-Funktionen sind kommentiert an der Spitze, mit einem format, dass ist mir unbekannt: /** * * Convert an object to an array * * @param object $object The

comments format function php phpdoc

phpDocumentor - could not open input file: phpdoc.php

7 Antworten

Ich versuche, phpDocumentor (für die erste Zeit, ich habe keine Ahnung, was ich Tue). Eigentlich möchte ich es nur mit SublimeText 2 und diese plugin. Kannst du mich führen, Schritt für Schritt, was soll ich tun damit

php phpdoc sublimetext2

Kann ich ein Skript ausführen, wenn ich zu Begehen, für die subversion?

4 Antworten

Ich würde gerne ein Skript ausführen, erstellt die Dokumentation für mein php-Projekt. Es ist im Grunde nur mit wget ausführen phpdoc. InformationsquelleAutor der Frage RobbieGee | 2008-09-26

hook phpdoc svn

Korrekte syntax für inheritDoc in phpDocumentor

2 Antworten

Was ist die korrekte syntax für @inheritDoc in phpDocumentor-wenn ich nur wollen, um zu Erben, alle Unterlagen von den Eltern? Vielleicht mehr als eine syntax korrekt ist? @inheritDoc {@inheritDoc} @inheritdoc {@inheritdoc} Die Dokumentation ist ziemlich vage, finde

inheritdoc php phpdoc

PHPDoc-type-hinting " für eine array von Objekten?

13 Antworten

So, in PHPDoc kann man angeben @var über die member-variable Deklaration Hinweis auf Ihren Typ. Dann eine IDE, die für die ex. PHPEd, wird wissen, welche Art von Objekt es ist, zu arbeiten mit und wird in

hint ide php phpdoc var

Anmerkungen zu einer lokalen variable in php

2 Antworten

Bin ich mit Eclipse PDT und ich will zu kommentieren, eine lokale variable mit Phpdoc. Alles, was ich sehe ist, dass ich mit dem Variablen/Eigenschaften einer Klasse mit @var oder sogar @propertyaber wie ist das möglich, eine

local php phpdoc variables

Best Practices: Verwendung von @throws in php-doc und wie es behandelt werden könnte

3 Antworten

Sagen wir, ich habe eine Klasse mit einer Methode wie diese: /* * * Loads the user from username. * * @param string $username The username * * @return UserInterface * * @throws userNotFoundException if the user

exception php phpdoc

Was ist der richtige Weg, um Dateien, Klassen und Konstruktoren zu dokumentieren?

4 Antworten

Was ist nützlich, die meisten/meisten standard - /am wenigsten überraschende Weise konsequent Kommentar schreiben-Bausteine für die Konstruktoren und Klassen und Dateien mit nur einer einzigen Klasse? Kommentar-Bausteine für die Klassen keine Konstruktoren Kommentar-Blöcke für Konstruktoren, Klassen nicht

php phpdoc

Was ist der richtige Weg, PHPDocs für Konstanten zu schreiben?

6 Antworten

Habe ich diesen code: /** * Days to parse * @var int */ const DAYS_TO_PARSE = 10; ... Ich glaube nicht, dass mit @var ist korrekt für eine Konstante und ich sehe keine @constant PHPDoc-Tags. Was ist

php phpdoc

Kommentar assoziatives Array in PHP Documentor

2 Antworten

Ich mehrere assoziative arrays in meiner PHP-Anwendung, und ich bin mit der PHP-documentor, zu kommentieren, meine Quellen. Ich habe nie wirklich geben Sie Kommentare für die arrays in einem array, aber jetzt muss ich das tun und

arrays associative-array php phpdoc

Gibt es eine Möglichkeit für phpDoc, ein Array von Objekten als Parameter zu dokumentieren?

4 Antworten

In phpDoc-Dokumentation, die ich verursachen kann, phpDoc generieren Sie einen link, um eine benutzerdefinierte Typ-definition für ein gegebenes param mit @param CustomType $variablename und das funktioniert Super. Allerdings ist der code ich bin momentan auf der Dokumentation

arrays custom-type phpdoc

PHPDoc optionaler Parameter

1 Antworten

Es gibt schon 2 ähnliche Fragen dieser Art hier auf, DAMIT aber keine der Antworten scheint zu funktionieren. PHPDoc-scheint nicht zu erkennen, optionale Parameter in meinen Funktionen als optional, zum Beispiel: /** * Opens the connection and

optional param php phpdoc

PHPDoc: @return void notwendig?

5 Antworten

Ist es wirklich notwendig, so etwas wie das hier tun: /** * ... * * @return void */ Ich habe schon ein paar Methoden, die keinen Rückgabewert, und es scheint wirklich überflüssig etwas zu setzen, wie dies

php phpdoc return-value

Der beste Weg, Array-Optionen in PHPDoc zu dokumentieren?

7 Antworten

Ich habe Mühe zu schreiben, lesbare und leicht verständliche Dokumentation, die beschreibt, die multi-tree-Struktur für Array-Optionen, die an eine Funktion übergeben werden. Hier ist ein Beispiel-array Struktur. $arr = array( 'fields'=>array( 'title'=>array('name'=>'Document.title','format'=>'string','readonly'=>true) ) ); Gibt es viele

cakephp php phpdoc

Variablentyphinweis in Netbeans (PHP)

5 Antworten

Nur neugierig, ob es einen Weg gibt in netbeans zu geben, geben Hinweise für die regulären Variablen, so dass intellisense in die Hand nimmt. Ich weiß, Sie können es tun, Klasse Eigenschaften, Funktion, Parameter, Rückgabewerte usw. aber

php php-ide phpdoc

Wie man Klasseneigenschaften in PHP 5 mit phpDocumentor dokumentiert

4 Antworten

Beachten Sie die folgenden PHP 5 Klasse: class SomeClass { //I want to document this property... private $foo; function __construct() { } public function SetFoo($value) { $this->foo = $value; } public function GetFoo() { return $this->foo; }

class php phpdoc

Parsen von PHP-Dokumenten in eine Datenstruktur

11 Antworten

Ich bin mit dem Reflection-API in PHP zum ziehen eines DocComment (PHPDoc) string aus, eine Methode $r = new ReflectionMethod($object); $comment = $r->getDocComment(); Dies wird eine Zeichenfolge zurückgegeben, die etwa folgendermaßen aussieht (je nachdem, wie gut die

parsing php phpdoc

Schließen Sie bestimmte Verzeichnisse und Dateien in pdepend, phpmd, phpcpd, phpcs, phpdoc, phploc aus

2 Antworten

In meinem Projekt gibt es bestimmte Verzeichnisse und bestimmte php-Dateien, die sehr groß in der Größe, aufgrund derer mein build fehlschlägt, und ausschließen will ich Sie in meinem build.xml Ques1- muss ich schreiben das --ignore="path/filename" für jede

jenkins php-codebrowser phpdoc phpunit

Dokumentation der phpDoc-Klassenkonstanten

2 Antworten

Wie dokumentiere ich Klasse-Konstanten für phpDoc? Ich habe die Anleitung gelesen, aber ich kann nichts finden über Sie. InformationsquelleAutor der Frage mck89 | 2010-10-08

class constants documentation php phpdoc