我想知道函数,变量或其他东西"在javascript中,它们是否具有相同的名称调用。或者你可以说我不知道如何在同一时间用相同的名字称呼它们。
例如,我有一个库,然后我为我的库的函数、成员、类和命名空间编写文档。那你怎么称呼我在做的事情呢,"记录">的事情;我的图书馆?',或'记录';组件"我的图书馆?我看到很多人说这是"公共接口",所以">记录我的库的公共接口",这是正确的称呼吗?
这个问题可能很蠢,但我已经尽力描述了,希望你们能帮助我,非常感谢!
Javascript是非常灵活的(人们非常害怕,他们做了typescript!) -所以当你记录你的代码,我建议调用你的代码实体的功能,而不是他们的形式。
列表的开头:
method: anything you can call e.g. doSomething()
class: A constructor with attributes and methods.
attribute: a variable inside a class.
class method: a method that changes the internal state of a class.
struct: A constructor with attributes but no methods.
有很多不同的词可以互换使用:
struct
与interface
相似attribute
有时也称为property
method
可称为function
class
可称为component
只要你在你的文档中保持一致,它就会看起来足够专业。