Tag: documentation-generation
Ein Dokumentations-generator ist ein Programmier-tool, das die Dokumentation erzeugt gedacht für Programmierer (API-Dokumentation) oder Endnutzer (End-user-Guide), oder beide aus einem set von speziell kommentierte source-code-Dateien, und in einigen Fällen, Binär-Dateien.
Was ist der Mathworks Weg zur Generierung von Matlab in der HTML-Dokumentation?
3 Antworten
Bin ich arbeiten auf gemeinsam genutzten Matlab-code, und wir möchten, zu teilen einer generierten Dokumentation als durchsuchbare HTML-Dokumente in unserem lokalen Netzwerk. Ich kenne die folgenden Methoden zum generieren einer Dokumentation: Schreiben Sie ein Programm, um C++-Dateien
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
Oracle-Dokumentation Generation Tool
1 Antworten
Ich würde gerne wissen, ob jemand weiß ein gutes tool zur automatischen Generierung von Dokumentation mit einer oracle 9i-Datenbank-schema. Ich habe eine reasearch und bisher fand DBSribe(www.leadum.com) aber ich habe problem mit, da es mir ein Fehler,
VS2010: automatisch generierte Dateien und XML-Dokumentation
4 Antworten
Ist dies wirklich nur re-Fragen diese Frage zu Visual Studio 2008. Macht VS2010 bietet keine Funktion, um loszuwerden, das CS1591 compiler-Warnung für automatisch generierten code? CS1591: Missing XML comment for publicly visible type or member Zitieren, der
Gibt es eine @inheritDoc entspricht in Doxygen?
2 Antworten
Ich weiß Javadoc erstellen {@inheritDoc}, aber was ist der Doxygen Weg, dies zu tun? InformationsquelleAutor Roberto | 2011-04-04
Visual Studio 2010 C# Kommentar/Documentation Generator
3 Antworten
Kennt jemand ein Visual Studio 2010 C# - plugin,: erlauben Sie mir zu leicht ändern (oder erstellen Sie eine neue) xml-Kommentar-Template. Ich muss hinzufügen, einige Benutzer-spezifische tags in die Vorlage. Zum Beispiel, wenn ich eine Methode kommentieren
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
Angular2 Dokumentations-Generator
2 Antworten
Gibt es einen Dokumentations-generator (kann eine Knoten-Paket) wie in anderen Programmiersprachen (jsdoc /phpdoc /javadoc /..) für typescript-basierten Angular2-Projekte? dgeni github.com/rangle/angular2-dgeni-starter Ja, danke/danke, dass ich jetzt auch diese Samen (github.com/mgechev/angular2-seed) hat npm run build.docs. Aber ich bräuchte eine
Generierung von Rest-API-Dokumentation mit swagger oder einem anderen tool
3 Antworten
Ich bin auf der Suche nach einem Weg, um Dokument-meine Rest-APIs. Mein server ist ein Tomcat/Spring-server und der Rest-APIs werden implementiert unter Verwendung von Jenkins. Swagger scheint eine ziemlich Coole Lösung, aber ich kann nicht herausfinden, wie
Swift-Dokumentation-Kommentare
5 Antworten
Ich habe ein paar Fragen über Swift-Dokumentation Kommentare. Gibt es irgendwie eine Verwandte Deklarationen im Abschnitt, wie einige der Apple-Dokumentation hat. Zum Beispiel, wenn ich die option+klicken Sie auf die tablewView(_:heightForRowAtIndexPath:) - Methode, verbindet es mich zum
Visual Studio habe eine option zur Erstellung von html-Dokumentation mit Javadoc-Stil Kommentare?
2 Antworten
Visual Studio eine option zum generieren von html-Dokumentation mit Javadoc-Stil Kommentare? Wenn ja, welche Schritte sind notwendig, um dies zu erreichen? In BlueJ gibt es eine option zum übersetzen Javadoc-Stil Kommentare in eine html-Datei. Wie das folgende
Wie man Microsoft HTML Help-2-Compiler?
1 Antworten
Wo kann ich laden Sie die Microsoft HTML Help-2-compiler (oder bounding SDK)? Ich möchte zum generieren von HTML-2-Dokumentation aus meiner Programmier-Projekte mit Sandcastle Help File Builder und dem Sandcastle Geführte Installation-Assistent wird angewiesen, die mir den download
Automatische generieren von REST API-docs von Symfony
1 Antworten
Gibt es eine einfache Möglichkeit zum generieren von Dokumentation für REST-api direkt von einem Symfony-Projekt? Welche version von symfony verwenden Sie? Wir sind mit symfony 2 Ich glaube nicht, dass es einen Weg gibt, um es automatisch
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
Wie erstellen Programmierung Flussdiagramm/Dokumentation von VB.NET source-code?
3 Antworten
welche tools verwenden Sie zum erstellen Programmierung Flussdiagramm/Dokumentation von VB.NET source-code? Es gibt absolut keine Kommentare/Dokumentation zu präsentieren. Ich bin ein Anfänger, d.h. ich habe versucht, Sandburg, aber es ist Weise über meinem Kopf und konnte es
Wie kann ich umwandeln RTF-Datei in eine pdf-Datei?
6 Antworten
Wie kann ich umwandeln RTF-Datei in eine PDF ein? Ich habe den adobe PDF-Drucker, sollte ich es verwenden? Wenn ja, wie kann ich programmgesteuert darauf zugreifen? Ich aktualisiert meine Antwort unten-so der Vorschlag von Henk, um eine
Automatische PHP-Dokumentation Generation?
9 Antworten
Für ActionScript 2, die ich verwendet habe,NaturalDocs. Allerdings hat es ziemlich schlechte Unterstützung für PHP. Ich habe mir bisher bei doxygen und phpDocumentor, aber deren Ausgang ist ziemlich hässlich, meiner Meinung nach. Hat jemand schon Erfahrung mit
so erzeugen Sie c# - Dokumentation in eine chm-oder html-Datei in visual studio 2012?
2 Antworten
habe ich gelesen,So erzeugen Sie C# - Dokumentation in eine CHM-oder HTML-Datei?. aber, ich benutze visual studio 2012 und allen die Antwort auf diese Frage ist in visual studio 2010 und niedriger. so, wie ich ihn generieren,
Programm produzieren kann Klassendiagrammen direkt aus dem code
2 Antworten
Habe ich eine etwas große C# - Projekt, das ich beginne mich zu verlieren überblick. Ich Frage mich, ob es eine software gibt, die könnte grafisch darstellen meine Klassen, die fordert, was, und so weiter. Ich habe
Referenz einer bestimmten Klasse, Methode mit @siehe Befehl mittels Doxygen
2 Antworten
War ich nicht in der Lage, auf eine konkrete Klasse Methode unter Verwendung der doxygen @siehe Befehl. Angenommen ich habe eine Klasse Server mit einer Methode starten, wie unten @interface Server : NSObject - (void) start:(NSInteger) mask;
wie zu api-Dokumentation generieren
4 Antworten
Schreiben brauche ich einige api-Dokumentation für die REST API, die ich erstellt habe. Gibt es tools, die stub eine nette html-Ausgabe im Stil der Unterstrich api-Dokumentation? Oder vielleicht etwas, das für die Ausgabe etwas wie ein twitter-bootstrap-Stil
Auto dokumentieren-REST-API in PHP
5 Antworten
phpDocumentor scheint der standard für die Dokumentation von PHP-code, obwohl ich Frage mich, warum es nicht aktualisiert wurde im Jahre..? Jedoch scheint es nicht geeignet für die Dokumentation der Eingabe-Punkte für eine REST-API; IE, von außen erreichbare
Wie dokumentieren Python-Funktion Parameter mit sphinx-apidoc unterbreitet
2 Antworten
Ich versuche es zu bereinigen, meine python-code-Dokumentation, und beschlossen,sphinx-docweil es gut aussieht. Ich mag, wie ich den Verweis auf andere Klassen und Methoden mit tags wie: :class:`mymodule.MyClass` About my class. :meth:`mymodule.MyClass.myfunction` And my cool function Ich versuche,
Was sind docstrings genannt in java?
2 Antworten
Bevor Java-Methoden haben wir so etwas wie: /** * Takes a number and returns its square root. * @param x The value to square. * @return The square root of the given number. */ public float getSqrt(float
Erstellen von html-doc von Postboten Sammlung
4 Antworten
Hab ich entwickelte einen ziemlich langen-API, und ich habe es auf den Briefträger, der funktioniert sehr schön. Jetzt habe ich zum generieren von html-doc zu halten, versioniert innen /docs zusammen mit meinen Quellen. Gibt es ein tool
Erzeugen von Word-Dokumenten (in Excel-VBA) aus einer Reihe von Dokument-Vorlagen
4 Antworten
Hey alle. Ich werde versuchen, diese kurz und einfach. 🙂 Ich habe 40 oder so boilerplate word-Dokumente mit einer Reihe von Feldern (Name, Adresse, etc), die ausgefüllt werden müssen. Dies ist historisch manuell gemacht, aber es ist
Generieren Sie HTML-Hilfedateien von VS 2010 C# - XML-Dokumentation
3 Antworten
Ich bin auf der Suche nach einem guten tool für das erstellen von HTML-Hilfedateien von meinem VS2010-XML-Dokumentation. Ich habe einige kommerzielle tools, wie .Net-Dokumentations-tool VSDocman Ich bin sicher, es gibt mehr, dass ich nur diese zwei als
Werkzeuge zum erzeugen einer Datenbank-Diagramm/ER-Diagramm aus vorhandenen Oracle-Datenbank?
9 Antworten
Suchen tools (windows-Plattform) zu genereate ER-Diagramm (oder ähnlich) aus einer vorhandenen Oracle-Datenbank. Irgendwelche guten tools gibt, die kostenlos zu benutzen oder low-cost? InformationsquelleAutor der Frage Kb. | 2010-01-19
Generieren Sie Protobuf-Dokumentation?
8 Antworten
Kennt jemand ein gutes tool zum generieren von Google Protobuf Dokumentation über die .proto source-Dateien? InformationsquelleAutor der Frage Markus K | 2011-02-14
Autodokumentation von Python mit Sphinx
5 Antworten
Dies ist eine verallgemeinerte version des Vorherige Frage bezüglich der Sphinx. Gibt es eine Möglichkeit, rekursiv autodocument Module oder packages, die Klassen enthalten, und Funktionen, die in Ihnen? Ich denke, es ist albern, fügen Sie die autofunction
Gibt es eine Möglichkeit, JavaScript-API-Dokumentation wie die Google Closure Library-API-Dokumentation zu erstellen?
5 Antworten
Ich versuche ein tool zu finden, der erzeugt HTML-Dokumentation für meine Javascript-Quellcode. Weiß jemand, ob das tool, das Google verwendet, um generieren die Schnittstelle unter den folgenden URLs ist open source? Ich wäre in der Lage zu
Objective-C-Dokumentationsgeneratoren: HeaderDoc vs. Doxygen vs. AppleDoc
3 Antworten
Brauche ich zur Umsetzung einer Dokumentation generation-Lösung für meinen Arbeitsplatz und haben es eingeengt zu den drei im Titel genannten. Ich habe in der Lage zu finden, sehr wenig Informationen in der Art von formalisierter Vergleich zwischen
Verwenden von Sphinx zum automatischen Dokumentieren eines Python-Klassenmoduls
1 Antworten
Habe ich installiert Sphinxum zu dokumentieren, einige python-Module und-Klasse, die ich arbeite. Während das markup language sieht sehr schön aus, ich habe noch nicht geschafft die auto-Dokument ein python-code. Grundsätzlich habe ich das folgende python-module: SegLib.py Und
Wie bekomme ich ein einzelnes PDF-Dokument von Doxygen?
5 Antworten
Wenn ich generieren die Doxygen-Dokumentation im PDF-format, bekomme ich viele verschiedene Dateien mit einem einzigen Diagramm. Ist es möglich, um ein einzelnes PDF-Dokument, organisiert wie ein Buch, etwa als HTML-version? Ist es auch möglich, es automatisch, d.h.
Wie bekomme ich eine mehrseitige Site von GitHub Pages automatischem Generator?
6 Antworten
Ich bin mit dem 'Automatischen Generator' von GitHub-Seiten, und ich sehe, es erzeugt nur eine einzige index.html und anderen web-Ressourcen. Wie es funktioniert, wenn ich ein multi-Seiten-website, generiert aus den anderen markdown-Dateien? InformationsquelleAutor der Frage Luigi R.
JSDoc: Rückgabeobjektstruktur
2 Antworten
Wie kann ich sagen JSDoc über die Struktur eines Objekts, das zurückgegeben wird. Ich habe festgestellt, dass @return {{field1: type, field2: type, ...}} description syntax und versuchte es: /** * Returns a coordinate from a given mouse
Hat Swift Dokumentationserstellungsunterstützung?
11 Antworten
Viele Sprachen unterstützen Dokumentation Kommentare zu ermöglichen, einen generator (wie javadoc oder doxygen) zur Generierung von code-Dokumentation durch analysieren, die denselben code. Stellt Swift eine Art Dokumentation Kommentar-Funktion wie diese? InformationsquelleAutor der Frage pconcepcion | 2014-06-04
Codedokumentation für Python
5 Antworten
Was ist da draußen auf Konventionen und Werkzeuge für die Dokumentation von python-Quellcode? InformationsquelleAutor der Frage Alex. S. | 2009-03-11
Verwenden Sie Doxygen mit C, kommentieren Sie den Funktionsprototyp oder die Definition? Oder beides?
5 Antworten
Ich bin mit Doxygen mit einigen embedded-C-Quelle. Gegeben ein .c/.h-Datei-pair-Mädchen, Sie setzen die Doxygen-Kommentare auf der Funktionsprototyp (.h-Datei) oder die definition einer Funktion (.c-Datei), oder Sie duplizieren Sie Sie an beiden Orten? Ich habe ein problem, in
Swagger mit statischer Dokumentation
2 Antworten
Ich bin auf der Suche zu verwenden Swagger zu dokumentieren, meine restful-Schnittstelle. Das problem ist, dass ich nicht wollen, um automatisch die Erstellung meiner Dokumentation von Anmerkungen zu meinem code. Im Grunde möchte ich nicht paar meiner
Namespaces mit Doxygen dokumentieren
2 Antworten
Habe ich Probleme mit Doxygen erkennen namespaces und Module. Ich glaube, das Thema umgibt, ob das \addtogroup in der namespace-oder außerhalb des namespace. Beispiel 1, außerhalb des Namensraumes: /*! * \addtogroup Records * @{ */ //! Generic
Tools und Anleitungen zum Dokumentieren von TypeScript-Code?
6 Antworten
Gibt es irgendwelche tools für die Generierung von Dokumentation für TypeScript-Quellcode? Oder sollte ich etwas generisch wie NaturalDocs? Was wäre die empfohlene Stil des block-Kommentare /diejenigen, welche für den standalone-Volumen-Dokumentation. Sollte ich verwenden: ///<foo>bar</foo> MSVS kind of
Wie füge ich Dokumentation für meine Funktionen in Netbeans PHP hinzu?
5 Antworten
Ich habe versucht, die folgenden, /* * addRelationship * * Adds a relationship between two entities using the given relation type. * * @param fromKey the original entity * @param toKey the referring entity * @param relationTypeDesc
Wie erstelle ich Dokumentation mit Pydoc?
4 Antworten
Ich versuche, ein Dokument erstellen, das aus meinem Modul. Ich verwendet pydoc von der Kommandozeile in Windows 7 mit Python 3.2.3: python "<path_to_pydoc_>\pydoc.py" -w myModule Dies führte zu meiner Hülle, gefüllt mit text, eine Zeile für jede
Wie dokumentiere ich eine Methode mit Parametern?
7 Antworten
Wie Dokument-Methoden mit Parameter mittels der Python-Dokumentation, strings? EDIT: PEP 257 gibt dieses Beispiel: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0)
Automatische PHP-Dokumentationsgenerierung?
9 Antworten
Für ActionScript 2, die ich verwendet habe,NaturalDocs. Allerdings hat es ziemlich schlechte Unterstützung für PHP. Ich habe mir bisher bei Doxygen und phpDocumentoraber deren Ausgang ist ziemlich hässlich, meiner Meinung nach. Hat jemand schon Erfahrung mit der
Graphviz für die Dokumentation
11 Antworten
Bemerkte ich, dass doxygen nutzt die graphviz-Bibliothek zur Erstellung von Diagrammen. Haben Sie jemals verwendet graphviz zur Generierung der Dokumentation? Lohnt es sich, das lernen der graphviz für Zwecke der Dokumentation, die außerhalb von doxygen? Oder bin
Kann LaTeX zur Erstellung von Dokumentation verwendet werden, die Software beiliegt?
12 Antworten
Zwar in Beziehung zu diese Frage zu LaTeX verwendet wird, die außerhalb der Mathematik und Wissenschaftich bin speziell Fragen, ob jemand oder kennt jemand, der LaTeX verwendet zur Erzeugung jeder Art von Dokumentation in Bezug auf software.
Dokumentation automatisch für alle Python-Paketinhalte generieren
3 Antworten
Ich versuche zum automatischen erzeugen von basic-Dokumentation für meine Codebasis mit Sphinx. Allerdings werde ich Schwierigkeiten haben, anweist Sphinx rekursiv Scannen meine Dateien. Habe ich ein Python-Codebasis mit einer Ordner-Struktur wie: <workspace> src mypackage __init__.py subpackageA __init__.py