Tag: documentation
DIESER TAG IST FÜR DOKUMENT-GENERATOREN NUR. Sprach-und/oder SDE-tag als gut. VERWENDEN Sie NICHT zu Fragen, für die links zur Dokumentation oder Werkzeuge, oder Kritik in der Dokumentation des Herstellers.
Legen Sie den relativen link in reStructuredText
1 Antworten
Dokumentiere ich eine Bibliothek, eine Python-Komponente und eine JavaScript-Komponente. Die Allgemeine Benutzer-Dokumentation, und die Python-API-Dokumentation sind in reStructuredText, verarbeitet mit Sphinx. Die JavaScript-API ist in der jsdoc-und verarbeitet werden, mit jsdoc-toolkit. Der AUFTRAGGEBER Ausgabeformat HTML. Ich bin
Was ist der beste Weg zum speichern von software-Dokumentation?
8 Antworten
So wie es momentan steht, diese Frage ist nicht eine gute Passform für unsere Q&A-format. Wir erwarten Antworten auf Tatsachen gestützt, Referenzen und know-how, aber diese Frage wird wahrscheinlich werben Debatte, Argumente, polling, oder erweiterte Diskussion. Wenn
Wie generieren Sie Microsoft Word-Dokumente mit Sphinx
8 Antworten
Sphinx unterstützt einige Ausgabe Formate: Mehrere HTML-Dateien (mit html oder dirhtml) Latex, die nützlich für die Erstellung von .pdf oder .ps text Wie bekomme ich die Ausgabe in eine Microsoft Word-Datei statt? Mit anderen doc-generator habe ich
Dokumentation einer javascript-Klasse, die mit Prototypen in einem namespace mithilfe von jsdoc-toolkit
2 Antworten
Ich versuche sehr hart, um Dokument-code in das format unter mithilfe von jsdoc-toolkit. Es sieht für mich wie die tags, die ich verwendet habe, erzeugen sollte, das gewünschte Ergebnis, aber es funktioniert nicht. Stattdessen warnt, dass die
RESTful-web-service-API-Dokumentation mit Sphinx
2 Antworten
Geschlossen. Diese Frage ist off-topic. Es ist derzeit nicht akzeptieren Antworten. mehr. verbessern Wollen dieser Frage? "Update" die Frage so ist es on-topic für Stack-Überlauf. Geschlossen letztes Jahr. Was ist der beste Weg, um markup-Methoden/- URLs für
Die Kombination von Sphinx Dokumentation von mehreren Teilprojekten: Umgang mit Indizes, die Synchronisierung Konfiguration, etc
2 Antworten
Haben wir ein multi-Modul-Projekt dokumentiert mit dem (hervorragenden) Sphinx. Unser setup ist nicht anders als eine wie auf der mailing-Liste. Insgesamt funktioniert Super! Aber wir haben ein paar Fragen über das tun so: Dem Submodul Inhaltsverzeichnisse gehören
Doxygen: Dokumentation überladene Funktionen
2 Antworten
Fall, ich habe mir die Dokumentation getrennt von meinem code, wie kann ich helfen, Doxygen unterscheiden zwischen überladenen Funktionen (was in der \fn Bereich)? Eine einzelne Funktion wäre dokumentiert wie dieses: void func() { } /** \fn
Beschreibung ASMX-web-service WebMethod-Parameter
3 Antworten
Dies scheint wie eine einfache Frage, aber ich habe nicht in der Lage, die Antwort zu finden online über viele Google-suchen. Ich habe ein C# - web-service und, wenn ich Besuch Ihre ASMX-Seite im browser, für eine
Wie können Sie sehen Feld Kommentare von mysql-client?
3 Antworten
Ich möchte sehen, wie die einzelnen Felder Kommentare. In der Regel etwas, was ich erwarten würde von "beschreiben" - Parameter. mysql> describe metrics; +-------+---------------------+------+-----+---------+----------------+ | Field | Type | Null | Key | Default | Extra |
Wo finde ich die Java ee-Pakete " Quellen?
2 Antworten
Entwickle ich ein Java ee-system (verteilt auf Weblogic App Server), aber ich habe nicht die Quellen für die Pakete Java ee (javax.ejb.*, für die Instanz). Wo finde ich die Quellen (kein javadoc) für diese Pakete? Die meisten
Kein mapping gefunden für Fors-Ressourcen/Konfiguration/Benutzeroberfläche
2 Antworten
Geschlossen. Diese Frage ist off-topic. Es ist derzeit nicht akzeptieren Antworten. mehr. verbessern Wollen dieser Frage? "Update" die Frage so ist es on-topic für Stack-Überlauf. Ich versuche zu konfigurieren swagger-ui nicht in spring-boot-app. Habe ich getan, folgende
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
Gibt es eine WEBGL-Handbuch?
8 Antworten
Gibt es irgendeine Art von WebGL-Handbuch, listet alle Funktionen etc. ? Ich habe versucht, Google aber nix gefunden. Du meinst so etwas wie dieses: khronos.org/registry/webgl/specs/1.0 ? Dieses tutorial könnte helfen, eine Menge, wie in meinem Fall. webglacademy.com
Wie finden Sie die enum-Konstanten in c# xml-docs
2 Antworten
Möchte ich Dokument der default-Wert einer enum-Feld eingetippt: ///<summary> ///The default value is <see cref="Orientation.Horizontal" />. ///</summary> public Orientation BoxOrientation; Der compiler warnt davor, dass es konnte nicht beheben, die Referenz. Präfix F: oder M: schweigen der
Wo soll die Dokumentation des Projekts gespeichert werden, in einer typischen maven-Projekt
3 Antworten
Wo sollte Projekt-Dokumentation (Anforderungen, etc.) gespeichert werden in einem typischen maven-Projekt. Keines der Verzeichnisse, die in Einführung in die Standard Directory Layout Seite ist ein offensichtlicher Kandidat. Ich würde abstimmen für '/docs'. Alles unter "/src " ist
gradle-publishing-Glas mit source-Dateien und Abhängigkeiten in POM
1 Antworten
Ich bin mit gradle, und ich möchte eine .jar mit source-Dateien, wenn dabei ein publishToMavenLocal. Ich habe, dass die Arbeit leicht: task jarWithSources(type: Jar) { from sourceSets.main.output if (gradle.startParameter.taskNames.any{it == "publishToMavenLocal"}) { from sourceSets.main.allJava } } publishing
Was ist der standard für die Dokumentation Stil in Bash-Skripten?
3 Antworten
Ich bin derzeit am schreiben eines Bash-Skript, dass hat eine Reihe von Funktionen in der it und möchte hinzufügen, Dokumente an andere team-Mitglieder zu verstehen, was der Sinn der Funktion ist. Ist es eine standard - "Stil"
Partikelsysteme Tutorial/Intro in Three.js
1 Antworten
Ich habe versucht zu finden, einige gute tutorials über Partikel-Systeme in Three.js,, aber noch nicht in der Lage, etwas zu finden, bemerkenswert. Gibt es eine Partikel-engine, dass wäre einfach zu bedienen, für die es, vielleicht mit ein
Wie, um Kommentare hinzufügen zu fenced code Blocks innerhalb von doxygen Dokumentation
2 Antworten
Ich bin mit fenced code blocks in Doxygen mit Hilfe der markdown-syntax. Dies macht es einfach, ein einfaches code-Beispiel, wie diese: ~~~~~{.cpp} void doSomething() { } ~~~~~ Wenn ich versuche, Kommentare hinzufügen in den eingezäunten code-block mit
Ganze site Zusammenstellung von markdown/pandoc?
3 Antworten
Mit Sphinx-doc, können Sie eine Reihe von ReStructureText Dateien, die mit einem index.rst - Datei, die ein Inhaltsverzeichnis-makro, auto-generiert ein Inhaltsverzeichnis von die andere Dateien enthalten, und ein conf.py wirkt wie eine Zusammenstellung config. Sie können dann
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,
Wie Sie richtig schreiben, Verweise auf externe Dokumentationen mit intersphinx?
5 Antworten
Ich versuche, fügen Sie Verweise auf externe API in meine Unterlagen, aber ich bin vor drei verschiedene Verhaltensweisen. Ich bin mit sphinx(1.3.1) mit Python(2.7.3) und meine intersphinx mapping konfiguriert ist als: { 'python': ('https://docs.python.org/2.7', None), 'numpy': ('http://docs.scipy.org/doc/numpy/',
How to-Dokument ein XML-Schema?
1 Antworten
Ich entwickelte ein XML-schema für eine Anwendung die ich geschrieben habe. Jetzt möchte ich Dokument gültige Struktur für den Endbenutzer, allerdings kann ich nicht kommen mit einem natürlichen Weg, dies zu tun. Ich habe Dinge gesehen, wie
"javadoc" in C#
1 Antworten
Bin ich auf der Suche online, um herauszufinden, wie "javadoc" in C# - Konsolenanwendung. Alle Artikel finden Sie ein Formular, von C# in dem Fall, für, dass, /// wäre in der javadoc. Was ist der Weg, es
Wo ist die Dokumentation über Pandas 'Freq' - tags?
1 Antworten
Ich bin neu Pandas, und versuche, mit date_range. Ich stieß auf alle möglichen guten Dinge für freq wie BME und BMS und ich möchte in der Lage sein, um schnell nachschlagen die richtigen Saiten zu bekommen, was
Eclipse : Liste der Methoden und Variablen für alle Klassen
6 Antworten
Ich bin seit einigen Java-code, der geschrieben wurde von jemand anderem. Muss ich das verstehen, ändern und testen Sie es. Der Autor ist momentan nicht verfügbar. Das Paket hat etwa 50 Dateien (und damit Klassen) in verschiedenen
Sphinx für php-code-Dokumentation
5 Antworten
Sphinx ist eine Python-Bibliothek zu generieren, die schöne Dokumentation aus einer Reihe von ReST-formatierten text-Dateien. Nicht das tool für die Volltextsuche Ich bin auch voll und ganz bewusst, doxygen /phpdoc-tools. Ich versuche herauszufinden, ob es ist ein
Gibt es echte alternativen zu reStructuredText für Python-Dokumentation?
7 Antworten
Ich ab, ein open-source-Python-Projekt in Kürze, und ich bin versucht, im Voraus zu entscheiden, wie das schreiben meiner docstrings. Die offensichtliche Antwort wäre, mit reStructuredText und Sphinx mit autodoc, weil ich wirklich mag die Idee einfach richtig
Gibt es eine Möglichkeit zu definieren generische Typen in JS Dokumentation?
1 Antworten
Ich bin auf der Suche nach Dokumentation generator für mein JS-Bibliothek. Ich finde JSDuck die umfassendste und kraftvoll. Aber ich sehe nicht, einen Weg zu definieren, geben Sie die Variablen für generische Klassen und Funktionen, die mit
Deaktivieren Sie die "Documentation Comments" Warnung für ausgewählte Dateien
3 Antworten
Xcode ist die Möglichkeit zu prüfen, für die Dokumentation Fragen und Kommentare Bericht Warnungen, wenn etwas nicht ganz richtig ist. Zum Beispiel, die ich Hinzugefügt habe, Facebook SDK, um mein Projekt mit CocoaPods. An einem gewissen Punkt
Beste Weg, um die Dokumentation für Entwickler, um Ihre Visual Studio-Projekte
4 Antworten
Im Grunde ist die Frage: Wo (und in welchem format soll ich meine store-textliche Dokumentation für Entwickler im Zusammenhang mit meiner Visual Studio-Projekte? Erarbeiten: XML-Kommentare sind toll, aber Sie decken nicht alle Einsatz-Fälle. Manchmal, Sie möchten, um
Mithilfe von doxygen zur Erstellung der Dokumentation für die bestehenden C# - code mit XML-Kommentaren
1 Antworten
Habe ich gelesen überall, dass doxygen ist der Weg zu gehen für die Generierung von Dokumentation für C# - code. Ich habe eine einzige Schnittstelle, die ich dokumentieren wollen ersten (baby -) Schritte, und es hat bereits
Wie kann ich erstellen .chm-Dateien aus C# - code?
6 Antworten
Ich verwendet doxygen zum erstellen von HTML-Dateien, jetzt möchte ich konvertieren, dass die Dokumentation in .chm-format. Wie kann ich dies tun? InformationsquelleAutor | 2009-04-01
Generieren Sie html-Dokumentation automatisch beim build mit Sandcastle
5 Antworten
Welche Schritte muss ich nehmen, um HTML-Dokumentation automatisch Gebäudes über den build-Schritt in Visual Studio? Ich habe all die Kommentare an Ort und Stelle und die comments.xml -Datei generiert wird, und Sandcastle installiert. Ich brauche nur zu
Ändern Sie das Thema Doxygen?
2 Antworten
Ich denke nicht wirklich, dass die Doxygen-HTML-Thema für die Dokumentation von C-code ist gut für die Dokumentation von Funktionen und Prozeduren (obwohl es genial ist für die Dokumentation von OOP, wenn mit C++). Also was ich verlange
Software - / System-Handover-Vorlage - gibt es gute Beispiele gibt?
1 Antworten
Bin ich verpflichtet, um eine übergabe an unsere content-Redaktion für die Aktualisierung der corporate website habe ich gerade veröffentlicht. Offenbar eine Trainingseinheit mit Noten ist nicht ausreichend. Fair genug. So mehr gefürchteten Dokumentation abzeichnet. Nach einer relativ
Wie kann ich die Verbindung zwischen markdown-Dokumente in doxygen?
4 Antworten
Habe ich ein Projekt mit einer Reihe von markdown-Seiten, die miteinander verbunden sind, mit links wie [Go to this page](subdir/MyOtherPage.md) Den Seiten alle abgeholt, die von doxygen und in der Ausgabe angezeigt, aber die links werden nicht
Python Docstring: raise vs. wirft
1 Antworten
Ich die PyCharm IDE hilft mit crafting PEP0257-konform docstrings. Es enthält zwei Attribute, die ich nicht ganz verstehen, die Unterscheidung zu/zwischen: :raise Exception: exception explanation here :raises Exception: exception explanation here Wenn würde ich raise als gegen
Controlling Doxygen die LaTeX-Ausgabe für die Herstellung der PDF-Dokumentation
3 Antworten
Ich bin mit Doxygen-Dokumentation generiert werden für meinen code. Ich brauche, um eine PDF-version dieses und die Benutzung von Doxygen der LaTeX-Ausgabe angezeigt wird, werden die Art und Weise, es zu tun. Aber ich habe laufen in
Wie sollten unit-tests dokumentiert werden?
5 Antworten
Ich versuche zu verbessern die Anzahl und Qualität der tests in meine Python Projekte. Eine der Schwierigkeiten ich gestoßen bin, als die Anzahl der tests erhöhen ist, zu wissen, was jeder test bedeutet und wie es '
Liste von Java-Swing-UI-Eigenschaften?
4 Antworten
Scheint es eine Tonne von UI-Eigenschaften eingestellt werden können, mit UIManager.put("key", value); Gibt es irgendwo eine übersicht aller Tasten, die festgelegt werden können? InformationsquelleAutor Epaga | 2009-12-23
Bei der Dokumentierung in Roxygen: Wie mache ich eine detaillierte Liste, in @Daten?
2 Antworten
Was ist die entsprechende syntax hinzufügen, um eine in Elemente untergliederte Liste zu roxygen2, zum Beispiel in der @Detailbereich? Kann ich ein latex-Liste-Umgebung? Scheint es, dass die Zeilenumbrüche werden einfach ignoriert, D. H. #' @details text describing
Docstrings - one-line-vs multiple-line
2 Antworten
Ich bin hinzufügen einige (epydoc) Dokumentation zu einem Paket, das ich geschrieben habe, und ich komme auf eine Vielzahl von Fällen, in denen ich wiederhole mich eine Vielzahl von Zeiten. def script_running(self, script): """Return if script is
Wo finde ich python ' s built-in Klassen mit Methoden und Attributen?
2 Antworten
Ich versuche, herauszufinden, welche Methoden und Attribute kommen mit der Mutter aller Ausnahme-Klassen in python: der Exception-Klasse. Aber, ich habe ein wenig Mühe, da die offizielle Anleitung scheint nicht zu zur Verfügung stellen. Die besten, die ich
Wie automatisieren die Dokumentation der REST API (Jersey Umsetzung)
7 Antworten
Ich geschrieben habe eine ziemlich umfangreiche REST-API, die mit Java Jersey (und JAXB). Ich habe auch geschrieben, die Dokumentation mit einem Wiki, aber es war ein völlig manueller Prozess, der sehr fehleranfällig, vor allem, wenn wir änderungen
Was ist das äquivalent von einem Python docstring in Ruby?
4 Antworten
In Python, können Sie den Zugriff auf ein Objekt docstring mithilfe obj.__doc__. Was ist die entsprechende Aktion in Ruby? Gut, vielleicht sollte man zuerst Fragen, ob Ruby hat docstrings an alle... InformationsquelleAutor parzival | 2011-02-15
Dokumentieren, C++/CLI-code-Bibliothek für die Verwendung von c# - besten-tools und-Praktiken?
5 Antworten
Arbeite ich an einem Projekt, wo ein c++/cli-Bibliothek verwendet wird in Erster Linie von einer c# - Anwendung. Gibt es eine Möglichkeit, um die code-Kommentare in c++/cli sichtbar zu c# intellisence innerhalb von visual studio? Vorausgesetzt, es
Erben-Dokumentation in C#?
7 Antworten
Aus Java und Eclipse bin ich auf @inheritDoc erlaubt, verwenden Sie die gleichen Unterlagen wie in der base-Klasse/- Methode. Wie kann ich erreichen, etwas ähnliches auch in C# und Visual Studio 2010? Siehe stackoverflow.com/questions/311363/... Vote for visualstudio.uservoice.com/forums/121579-visual-studio/...
Wie eine Methode zu dokumentieren, die eine andere Methode überschreibt?
2 Antworten
Ich mich immer gefragt, wie eine Methode zu dokumentieren, der überschreibt eine Nachricht, die von einer Basisklasse. Normalerweise füge ich ein java-doc an jede öffentliche Methode und einige private, protected-Methoden. Aber autogenerating eine Dokumentation block für eine
Batch-scripting-Dokumentation
7 Antworten
Gibt es einige schöne Dokumentation für Windows-batch-scripting-ich kann laden und Lesen, während man offline ist? InformationsquelleAutor Dean Rather | 2008-11-07