在API文檔中,有時甚至在Stack Overflow的討論中使用,有時我會使用磅(#)字符而不是點(。)作爲類名和方法名之間的分隔符。例如:使用#代替。在API文檔中
Settings#maxPageSize
我想知道這個用法是什麼意思,它來自哪裏?
在API文檔中,有時甚至在Stack Overflow的討論中使用,有時我會使用磅(#)字符而不是點(。)作爲類名和方法名之間的分隔符。例如:使用#代替。在API文檔中
Settings#maxPageSize
我想知道這個用法是什麼意思,它來自哪裏?
我一直認爲,區別在於Settings.maxPageSize
似乎在暗示,你其實可以寫這一點(即它是一個靜態方法),以及英鎊有表示,這僅僅是一個引用一個方法,而不是你可以執行的一段代碼。
雖然我可能是完全錯誤的關於這個=)
所以對於靜態方法,你實際上可以參考他們Settings.maxPageSize
,但對於實例方法,你必須想出一個新的公約,這樣的選擇作爲Array#sort
來表示一些特別的東西是怎麼回事,或者達到相同的完整性,你必須寫
myArray.sort // when myArray is of the type Array
編輯
Amadan的回覆似乎證實了我的解釋,除了Settings.maxPageSize
不用於靜態方法;相反,那將是Settings::maxPageSize
和.
完全保留用於示例代碼,這對我來說是有意義的。
假設你的意思的Ruby(這是我可以用這樣的慣例想到的第一語言),它是在這裏解釋:
Why are methods in Ruby documentation preceded by a hash sign?
鏈接的例子嗎? – Andrey 2010-05-19 14:34:14