代码之家 › 专栏 › 技术社区 › Landon Kuhn

用#代替。在API文档中[关闭]

documentation ruby

Landon Kuhn · 技术社区 · 15 年前

在API文档中,有时甚至在这里讨论堆栈溢出时,我有时会看到在类名和方法名之间使用pound(#)字符而不是dot(.)作为分隔符。例如:

Settings#maxPageSize

2 回复 | 直到 15 年前

Community CDub 8 年前

假设您指的是Ruby(这是我在这种约定中可以想到的第一种语言),这里将解释如下:

David Hedlund 15 年前

我一直认为区别在于 Settings.maxPageSize 似乎意味着你实际上可以这样写(即它是 静止的 方法的引用,而不是一段可以执行的代码。

所以对于静态方法,实际上可以引用它们 设置.maxPageSize Array#sort

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

编辑

设置.maxPageSize 也不用于静态方法;而是 Settings::maxPageSize ,和 .

推荐文章

Alvaromon · 如何使用ReSharper获取C#样式的三斜杠注释++

7 年前

Shepmaster Tim Diekmann · 如何基于功能标志有条件地执行模块级doctest?

7 年前

depaulagu · react本机文档是如何制作的?

7 年前

yearntolearn · R包命名空间

7 年前

Jean-Baptiste Yunès · 如何在XCode中记录Swift函数的参数标签和非参数名称?

7 年前

Dimebag · dict的Python NumPy风格文档

7 年前

m00am · 如何对使用板条箱特性的函数进行doctest?

7 年前

zython Hiery Nomus · Aiohttp errno代码文档?Errno-2/111/113/104/101[关闭]

7 年前

userMod2 · 节点-遍历JS文件的文件夹并提取某些位[关闭]

7 年前

ian · ri中记录的关键字方法参数在哪里?[已关闭]

7 年前