代码之家  ›  专栏  ›  技术社区  ›  Josh Andreas Rehm

引用带有pound/hash符号的javascript实例方法

  •  11
  • Josh Andreas Rehm  · 技术社区  · 14 年前

    这个问题与 Why are methods in Ruby documentation preceded by a hash sign?

    我理解为什么在ruby实例中方法是用一个磅符号来进行的,这有助于区分 SomeClass#someMethod SomeObject.someMethod 并允许 rdoc 工作。我知道prototypejs的作者很欣赏ruby(有充分的理由),所以他们使用 hash mark convention in their documentation .

    我的问题是:这是javascript开发人员的标准实践,还是仅仅是原型开发人员做的?

    另一方面,我是否应该在注释/文档中引用实例方法 某某类某某方法 ?或者我的文档应该引用“someClass.someMethod”?

    2 回复  |  直到 7 年前
        1
  •  4
  •   Pablo Cabrera    14 年前
        2
  •  10
  •   bobince    14 年前

    不,我还没有遇到另一个使用这种符号的javascript项目。

    不过,类似这样的东西在javascript中很有用,因为与许多语言不同 Class.methodName 会引用类方法,如 String.fromCharCode ,而不是你经常说的实例方法。调用的方法 myinstance.methodName 将不会 MyClass.methodName 但是 MyClass.prototype.methodName MyClass.prototype 不停地打字是一种烦恼。

    (标准js库通过使许多实例方法也具有相应的classmethod来混淆这一点。但它们有不同的功能。)

    对我来说,将注释/文档中的实例方法称为someclass somemethod是不是很有必要?

    做你喜欢做的事/觉得最有可读性。这里没有标准。