Convention de nommage lorsqu'il est fait référence de manière informelle aux méthodes en Java

Question

Y a-t-il une convention Java pour faire référence aux méthodes, static et autres, à une spécifique ou à toutes les surcharges, etc?

par exemple

• String.valueOf - faisant référence à toutes les surcharges de static valueOf
  • String.valueOf(char) - surcharge spécifique, nom du paramètre formel omittable?
• String.split - ressemble à une méthode statique, mais en réalité une méthode d'instance
  • Peut-être aString.split est la convention?
  • Ou peut-être String().split?
• String#split - J'ai également vu cette forme d'ancre HTML, influencée je suppose par javadoc

Y a-t-il une recommandation officielle sur la manière de faire clairement référence à ces éléments?

Answer 1

Utiliser Class.methodName pour faire référence à toutes les surcharges et Class.methodName(type) pour faire référence à une surcharge spécifique est en effet la convention (comme recommandé par sun dans ce guide de style pour les javadocs). Cependant, il n'y a pas de convention pour distinguer entre les méthodes statiques et non statiques (bien que aString.split aurait du sens).

Answer 2

Dépend du contexte dans lequel vous souhaitez les mentionner. Personnellement, j'ai tendance à utiliser des liens de style Javadoc partout (dans les Javadocs, mon blog, les messages de forum, etc.) et préfère également les rendre cliquables, bien que j'avoue ne pas être cohérent avec les arguments de méthode lorsqu'ils sont utilisés en dehors des Javadocs (je suis un peu trop paresseux à ce sujet, Eclipse propose l'autocomplétion des balises @link ;)). En ce qui concerne les recommandations officielles, il n'y a, autant que je sache, que la recommandation de lien Javadoc.