rdoc

10Hitze

2Antwort

Wie dokumentiert man eine Schienenanwendung?

Ich habe gerade begonnen, eine Schienenanwendung zu dokumentieren. Ich weiß, dass dies von rdoc gemacht wird, also habe ich einige rdoc-Anleitungen bezüglich Syntax usw. befolgt, aber ich blieb stecke

16Hitze

1Antwort

YARD ist nicht dasselbe wie RDoc?

Korrigieren Sie mich, wenn ich falsch liege, ist YARD nicht dasselbe wie RDoc? Es basiert nicht auf RDoc, aber eine komplette Neuschreibung? Also, wenn ich YARD verwende, muss ich mich nicht mit RDoc

27Hitze

1Antwort

Yard und Links zu Klassen/Module in der doc

Ich bin derzeit Wechsel von Rdoc zu Hof für meine Ruby-Software-Dokumentation. In meinem doc ich häufig wird einige Klassen/Module aus den Kommentaren, zum Beispiel: ## == Provides various utility fea

3Hitze

3Antwort

Wie stelle ich eckige Klammern ([]) in RDoc?

Ich versuche, einige Rake-Aufgaben zu dokumentieren, die ich mit RDoc-Kommentaren in meiner Klasse geschrieben habe, und stehe in Schwierigkeiten, eckige Klammern darzustellen. Ich möchte einige Beisp

0Hitze

2Antwort

Wie bearbeite ich eine Readme-Datei mit Rdoc zur Anzeige von Ruby Skript Hilfe/Nutzungsinformationen

Ich möchte meine Verwendung Dokumentation in einer Readme-Datei (duh) statt Kommentare an der Spitze meines Skripts zu halten. Wie erhalte ich RDoc :: Verwendung, um die Nutzungsinformationen aus der

8Hitze

2Antwort

Was ist die Begründung/Geschichte für die # Konvention, Methoden in Ruby zu identifizieren?

Zum Beispiel habe ich immer Methoden als String#split, aber nie String.split, die etwas mehr logisch erscheint. Oder vielleicht sogar String::split, weil Sie #split im Namespace String betrachten könn

0Hitze

2Antwort

In Gem-Server "rdoc nicht installiert", aber rdoc in Terminal

Wenn ich Server gem Gem und gehe auf die Seite, stelle ich fest, es gab keinen Link zu der RDoc, und wenn ich dorthin bewegen ein Pop-out sagt RDoc ist nicht installiert. Aber wenn ich rdoc --help in

14Hitze

2Antwort

Wie man Rdoc für alle installierten Edelsteine wieder aufbaut?

Ich habe mehrere Edelsteine an mehreren Orten installiert. Was ist die harte/einfache Weise zu generieren/neu generieren: rdoc für alle diese installiert Edelsteine, die alle auf einmal? yardoc für

0Hitze

2Antwort

Warum gibt ri unter Windows nichts zurück?

Wenn ich ri an der Kommandozeile ein gibt nichts zurück: Klassen und Module ri bekannt: Wie kann ich das richtig eingestellt? Vielen Dank.

32Hitze

3Antwort

Was ist der Unterschied zwischen ri und rdoc

Immer wenn ich Edelsteine installiere, sehe ich, dass ri und rdoc folgen. Ich weiß, das ist Dokumentation, aber was ist der Unterschied zwischen den beiden und wie man sie benutzt?