Qual è il modo più veloce per accedere alla documentazione di Ruby? [chiuso]

Question

Supponiamo che stia scrivendo un codice ruby ??e voglio usare il tipo di data standard per ottenere la data corrente. Invece di utilizzare un motore di ricerca, esiste un modo più rapido per trovare la documentazione per questa classe? So di poter ottenere i metodi per Date digitando Date.methods , ma per quanto ne so questo non fornisce dettagli sui tipi di argomenti o sul valore restituito.

Le risposte specifiche dell'editor sono benvenute. Il mio editor preferito è Emacs.

Answer 1

Aggiungi il ai segnalibri di ruby ??core

Usa il comando find-text del tuo browser web.

Per quanto possa sembrare inaspettato, trovo che in realtà sia più veloce dell'uso di ri , che per qualche motivo sembra impiegare molto tempo per avviarsi.

È anche molto meglio di ri perché la pagina HTML elenca tutta la documentazione per tutti i metodi su una singola pagina. Spesso i metodi sono correlati ad altri e il passaggio tra 2 ri è doloroso

Answer 2

Sulla tua console usa " ri "

ri Date

Funziona con tutte le classi. (ad es. ri String) Per visualizzare la documentazione per un metodo particolare, utilizzalo come segue:

ri Date#yourMethod

Answer 3

La fonte canonica per la documentazione di Ruby è Ruby-doc - i due link lì che sono i più l'interesse è core e libreria standard . Ottieni una rappresentazione in stile javadoc che di solito copre tipi di argomenti e valori di ritorno. Puoi persino crearne uno tuo con RDoc .

Answer 4

Per quelli di voi che desiderano documenti dall'IRB vanilla

1. Segui queste istruzioni per l'impostazione del RI centrale documentazione. Al momento della scrittura, i passaggi sono

   $ cd ~/.rvm/src
   $ rvm docs generate-ri
   

2. Ora puoi visualizzare i documenti per un metodo specifico sulla riga di comando usando il comando ri . Per invocarlo dall'IRB, utilizzare il comando help:

   $ irb
   irb(main):001:0> help 'String#chomp'