在文档中定义Javascript对象的类

class definition for Javascript Objects in documentation

本文关键字:对象 Javascript 定义 文档      更新时间:2023-09-26

我正在开发一个javascript库,由一个主要对象组成,它作为一个静态类工作,并包含做同样事情的各种对象。
我在找到引用文档中的对象的最佳方法时遇到了麻烦,因为我使用jGrouse,它将它们称为类,如:

public Class myLibrary

这些对象和它的子对象都不会有任何原始类型变量,也不会有任何关联的工厂模式,所以它们不会被重新实例化。

我不能给你展示一个活生生的例子,但我会尽量在这里放一个类似的例子:

var myLibrary = {};
myLibrary.methodOne = function(){ ... };
myLibrary.methodTwo = function(){ ... };
// this is a sub-library that will encapsulate methods for Array type operations
 myLibrary.Array = {};
 myLibrary.Array.forEach = function(array, function(item));
 (...)
// this is a sub-library that will encapsulate methods for Event type operations
myLibrary.Events = {};
(...)

所以,我不认为这是正确的参考myLibrary, myLibrary。数组和myLibrary。事件作为类,原因很明显,它们不应该被实例化。
我拒绝将它们称为静态类,因为Javascript本身并不是为使用静态类而设计的。
我认为对象和内部对象或静态对象可能也不是方法。

我正在寻找在我的公共文档中识别它们的最佳方法,以免混淆没有经验的程序员,也不会侮辱更高级的开发人员。

帮忙吗?谢谢

您可能正在查找术语"namespace"。

你真的不应该那么担心正确的单词。它们都太模糊了,在JavaScript亚文化中有着完全不同的含义。

文档中重要的一点是"事件有这些方法"。

我想看方法签名,我想看它们做什么的高级描述,我想看一个例子。