使用＃代替。在API文档中

Question

在API文档中，有时甚至在Stack Overflow的讨论中使用，有时我会使用磅（＃）字符而不是点（。）作为类名和方法名之间的分隔符。例如：

Settings#maxPageSize 

我想知道这个用法是什么意思，它来自哪里？

Answer 1

我一直认为，区别在于Settings.maxPageSize似乎在暗示，你其实可以写这一点（即它是一个静态方法），以及英镑有表示，这仅仅是一个引用一个方法，而不是你可以执行的一段代码。

虽然我可能是完全错误的关于这个=）

所以对于静态方法，你实际上可以参考他们Settings.maxPageSize，但对于实例方法，你必须想出一个新的公约，这样的选择作为Array#sort来表示一些特别的东西是怎么回事，或者达到相同的完整性，你必须写

myArray.sort // when myArray is of the type Array 

编辑

Amadan的回复似乎证实了我的解释，除了Settings.maxPageSize不用于静态方法;相反，那将是Settings::maxPageSize和.完全保留用于示例代码，这对我来说是有意义的。

Answer 2

假设你的意思的Ruby（这是我可以用这样的惯例想到的第一语言），它是在这里解释：

Why are methods in Ruby documentation preceded by a hash sign?