Als «doc» getaggte Fragen

864
Wie verweise ich auf eine Methode in Javadoc?

Wie kann ich das @linkTag verwenden, um eine Verknüpfung zu einer Methode herzustellen? Ich will es verändern: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz...

629
Wie funktioniert "cat << EOF" in Bash?

Ich musste ein Skript schreiben, um mehrzeilige Eingaben in ein Programm einzugeben ( psql). Nach einigem googeln stellte ich fest, dass die folgende Syntax funktioniert: cat << EOF | psql ---params BEGIN; `pg_dump ----something` update table .... statement ...; END; EOF Dadurch wird...

531
Beispiel für mehrzeiligen Code im Javadoc-Kommentar

Ich habe ein kleines Codebeispiel, das ich in den Javadoc-Kommentar für eine Methode aufnehmen möchte. /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); *...

417
PHPDoc-Typ, der auf ein Array von Objekten hinweist?

In PHPDoc kann man also @varüber der Deklaration der Mitgliedsvariablen angeben, um auf ihren Typ hinzuweisen. Dann eine IDE, zum Beispiel. PHPEd weiß, mit welcher Art von Objekt es arbeitet, und kann einen Code-Einblick für diese Variable geben. <?php class Test { /** @var SomeObj */ private...

374
Wie ordne ich einer Variablen in Bash einen Heredoc-Wert zu?

Ich habe diese mehrzeilige Zeichenfolge (Anführungszeichen enthalten): abc'asdf" $(dont-execute-this) foo"bar"'' Wie würde ich es einer Variablen mit einem Heredoc in Bash zuweisen? Ich muss Zeilenumbrüche beibehalten. Ich möchte den Zeichen in der Zeichenfolge nicht entkommen, das wäre...

316
Wie beschreibe ich "Objekt" -Argumente in jsdoc?

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } Aber wie beschreibe ich, wie das Parameterobjekt strukturiert sein soll? Zum Beispiel sollte es so etwas sein wie:...

230
Javadoc: package.html oder package-info.java

Was ist die bevorzugte Methode, wenn Sie versuchen, Javadoc-Kommentare auf Paketebene zu erstellen? Wie geht's? package-info.java Vorteile Neuer Nachteile Missbrauch einer Klasse - Klassen sind für Code gedacht, nicht nur für Kommentare package.html Vorteile HTML-Erweiterung bedeutet, dass es kein...

192
Verwenden von Variablen in einem Bash-Heredoc

Ich versuche, Variablen innerhalb eines Bash-Heredocs zu interpolieren: var=$1 sudo tee "/path/to/outfile" > /dev/null << "EOF" Some text that contains my $var EOF Dies funktioniert nicht wie erwartet ( $varwird wörtlich behandelt, nicht erweitert). Ich muss verwenden, sudo teeweil das...