Pourquoi méthodes de documentation de Ruby précédée par un signe dièse?

C'est quelque chose qui a été mise sur écoute de moi pendant un moment. Quand je vois toute méthode Ruby imprimé dans le texte, il apparaît que:

Class#method

#method

Maintenant, je voudrais utiliser:

Class.method

Pourquoi toutes les méthodes Ruby précédée par un signe dièse? Est-il une raison pour cela? Juste curieux.

Quand est-il de la date de retour pour?

InformationsquelleAutor Ed S. | 2009-04-09

documentation ruby

16

De la rdoc docs:

Noms des classes, des fichiers source, et
toute méthode de noms contenant un
trait de soulignement ou précédée par une table de hachage
caractère sont automatiquement
hyperlien à partir de texte de commentaire à leur
description.

(Italiques ajoutés.)

InformationsquelleAutor Sarah Mei
100

Noter que la convention est:
```
Class#method
```
plutôt que
```
object#method
```
Dans le code, vous avez object.method, si object était une instance de class. Le # convention n'est pas utilisé dans le code.

De le RDoc documentation:

Utilisation :: pour décrire les méthodes de la classe, # pour décrire les méthodes d'instance, et de l'utilisation . par exemple, le code.
- Oui, désolé, Classe#Method. Merci.
- Je sais que ce n ° n'est pas utilisé dans le code, mais pourquoi est-il utilisés?
- Le lien semble avoir rouillé mais assez, a été cité pour me permettre de trouver une source de courant: ruby-doc.org/documentation-guidelines.html
- merci, lien mis à jour.
InformationsquelleAutor Simon Nickerson
28

La # notation est utilisée pour se référer à l'canonique instance méthode, comme String#upcase. L' . la notation est utilisé pour se référer à la méthode d'une instance particulière, comme mystring.upcase. La distinction est faite de ne pas impliquer qu'une méthode de la classe 'upcase' existe.

InformationsquelleAutor dstnbrkr
18

Je viens de réaliser qu'aucune des autres réponses toucher le plus trivial aspect de la question: pourquoi le # signe?

J'ai deux théories:
1. Il pourrait venir de Smalltalk, où les symboles sont écrits #sym (au lieu de :sym) car ils sont en Ruby. Donc, si vous voulez reportez-vous à une Méthode objet (par opposition à appel une méthode de), vous devez appeler quelque chose comme Array >> #new. (Le >> est elle-même une méthode qui retourne la méthode transmis. Donc, en Ruby qui serait Array.method :new.) En Smalltalk documentation, les méthodes sont généralement appelés Class>>method, mais en Ruby Class:method aurait fait plus de sens, sauf qu'il est facilement confondu avec Class::method. Par conséquent, Class#method a été choisi.
2. Mon autre théorie est qu'il a été choisi parce que # est le caractère de commentaire en Ruby.
Une réponse définitive ne peut être donnée que par celui qui l'a inventé cette convention. Si elle a été inventée pour la de Programmation Ruby livre, qui serait soit de Dave Thomas ou Andy Hunt, mais j'en doute. Le livre est sorti en 2001, Ruby a commencé en 1993, comment ont-ils référence à des méthodes avant?
- J'ai entendu dire que la pragmatique programmeurs créé la documentation de Ruby ainsi (ils voulaient les semences de la documentation afin que d'autres pourraient être "trompé" en ajoutant à cela). git peut vous prendre à partir de 1998, de sorte que vous pouvez vérifier si Class#method_name qui s'est passé avant le prag progs ajouté.
- Depuis, j'ai entendu dire que la documentation n'existe pas avant le prag progs commencé à ajouter dans le code source.
- C'est peut-être imiter le look de la # ancre de syntaxe dans le code HTML. Par exemple somesite.com/somepage#section.
- Je seconde ce. En l'absence de toute définitif des ressources de pourquoi # a été choisi, j'ai toujours trouvé que l'explication la plus probable à être les points d'ancrage utilisés pour passer à une méthode particulière dans la documentation de Java est l'utilisation de la même convention est largement soupçonné d'être de cette origine.
InformationsquelleAutor Jörg W Mittag
7

Toutes les réponses ci-dessus vous liste sont corrects. La seule chose que je voudrais ajouter, c'est que la documentation style vous avez dit que vous perfer

Classe.méthode

pourrait être facilement confondu avec les méthodes de la classe. Puisque vous pouvez appeler les méthodes de la classe en ruby en utilisant la syntaxe ci-dessus:
```
class Foo
  def self.say_hi
    puts "hi"
  end
end

Foo.say_hi    # => prints "hi"
```
InformationsquelleAutor
3

Cela a été mentionné dans le JS version de cette question, mais il semble probable que cette nomenclature est venu de JavaDoc où la marque de hachage est traduit directement dans une page de référence, par exemple href="Component.html#getComponentAt(int, int)"
- Hein, j'avais été demandais pourquoi Javadoc exige que l'usage, mais je ne pensais pas que la raison d'être aussi banal.
InformationsquelleAutor heff
1

heff de la réponse (que je ne peux pas commenter en raison du manque de réputation), que Ruby suivi JavaDoc de l'exemple, est la plus plausible à mon avis. La JavaDoc concepteurs nécessaire ou voulu un façon de distinguer paquet qualificatifs (où ils ont utilisé le point d') de la classe qualificatifs (où ils ont utilisé le hachage). JavaDoc s @voir et @link balises la syntaxe ressemble à ceci:
```
@see   package.class#member [optional label]
{@link package.class#member [optional label]}
```
Consultez la documentation de JavaDoc de l'package.class variante de la balise @see et la documentation JavaDoc de @balise de lien, qui heff déjà souligné.

Dans la JavaDoc, le nom de package peut souvent être omis, de sorte que seule la Classe#membre reste la partie, ce qui semble tout aussi étrange, comme en Ruby, parce que le code Java utilise la Classe.membre de la syntaxe,
juste que Ruby n'.

Il serait intéressant de savoir pourquoi la JavaDoc concepteurs besoin de la syntaxe différente, tandis que le compilateur Java ne fine avec des points pour les deux fins.

InformationsquelleAutor Rainer Blome

Vous devez vous connecter pour publier un commentaire.