documentation

DIESER TAG IST NUR FÜR DOKUMENTGENERATOREN. Fügen Sie auch Sprache und / oder SDE-Tag hinzu. Verwenden Sie KEINE VERBINDUNGEN, um Links zu Dokumentationen oder Tools anzufordern oder die Herstellerdokumentation zu kritisieren.
2
Antworten

Wie lege ich Codebeispiele in .NET XML-Kommentare ab?

Welche Tags kann ich zum Einfügen von Codebeispielen in .NET /// XML-Kommentare verwenden?     
12.08.2009, 21:03
2
Antworten

Docstrings - eine Zeile vs. mehrere Zeilen

Ich füge eine ( epydoc ) Dokumentation zu einem Paket hinzu, das ich geschrieben habe, und ich bin es auch Ich begegne vielen Fällen, in denen ich mich viele Male wiederhole. %Vor% PEP257 sagt Folgendes:    One-Liner sind für wirklich o...
22.02.2012, 09:25
6
Antworten

Dokumente im automatisierten Build generieren

Gibt es eine Möglichkeit, Projektdokumente während automatisierter Builds zu generieren? Ich hätte gerne ein einziges Set von Quelldateien (HTML?) mit dem Benutzerhandbuch und von ihnen generieren: PDF-Dokument CHM Hilfe HTML-Version...
22.09.2008, 10:06
1
Antwort

Funktion aus dem R-Paket-Handbuch ausschließen

Ich schreibe ein R-Paket und dokumentiere alle meine Funktionen mit roxygen2. Ich möchte jedoch nicht, dass alle Funktionen im Handbuch des Pakets erscheinen. Wie kann ich angeben, welche Funktionen im Handbuch des Pakets erscheinen sollen oder...
04.03.2016, 17:00
4
Antworten

Python Sphinx verweist auf lange Namen

Ich arbeite an der Dokumentation für mein Python-Modul (mit Sphinx und reST), und ich finde, dass beim Querverweisen auf andere Python-Objekte (Module, Klassen, Funktionen, usw.) der vollständige Objektname unglaublich ist lange. Oft sind es meh...
05.04.2012, 18:52
3
Antworten

Hinzufügen von XML-Dokumentation / Kommentaren zu Eigenschaften / Feldern in EF-generierten Klassen

Ich habe die Gewohnheit, Eigenschaften und Klassen mit der Standard-XML-Dokumentation zu kommentieren, was es bedeutet / was sie tun. Aber in EF generierten Klassen sind das natürlich alle weg, wenn ich das Modell neu generiere. Gibt es ei...
06.10.2011, 09:46
1
Antwort

PHP: Die Reflection-API - großartige Ergänzung zu PHP mit wenig Nutzen [geschlossen]

Reflection API ist eine großartige Sache da draußen, um das OOP-Zeug zu manipulieren, und es sieht so aus, als ob die meisten Entwickler sich dessen gar nicht bewusst sind oder es nie benutzt haben. Reflection-API-Ansprüche:    PHP 5 kom...
04.03.2010, 07:17
3
Antworten

Wie dokumentiert man eine Factory, die eine Klasse in angular mit ngdoc zurückgibt?

Eine eckige App mit einer Factory, die eine Klasse als solche zurückgibt: %Vor% Wie kann ich mithilfe von ngdoc (der speziellen Variante von jsdoc angular uses) den Initialisierer dokumentieren, ohne ihn als Methode zu definieren?...
04.04.2015, 16:40
2
Antworten

Wie füge ich "Hilfe" -Text zu einer Mex-Funktion hinzu?

Ich schreibe eine Matlab-Mex-Datei. Allerdings scheinen mex-Dateien eine ernsthafte Einschränkung zu haben: help mexfilename wird nicht dazu führen, dass ein Hilfetext erscheint. Ich könnte das umgehen, indem ich eine m-Datei schreibe, die...
10.02.2009, 13:57
1
Antwort

Ist der Zugriff auf Schienenführungen für Schienen 2.3 möglich? [geschlossen]

Früher waren die Ruby on Rails Guides für Version 3.0 auf Ссылка und die Guides für Version 2.3 waren Ссылка . Jetzt, da Version 3 veröffentlicht wurde, wurden seine Handbücher in die Haupt-URL verschoben. Gibt es eine Möglichkeit, auf die...
15.09.2010, 15:12