文档中Javascript对象的类定义

时间:2011-12-16 15:41:50

标签: javascript oop documentation

我正在开发一个由主对象组成的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.Array和myLibrary.Events作为类引用是不正确的,原因很明显它们并不是要实例化的。
我拒绝将它们称为静态类的想法,因为Javascript本身并不适用于静态类 我认为对象和内部对象或静态对象可能也不是可行的方法。

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

有任何帮助吗? 感谢名单

1 个答案:

答案 0 :(得分:1)

你可能正在寻找术语“命名空间”。

你真的不应该担心这个正确的词。这些都太模糊了,并且在JavaScript子文化中有几个不同的含义。

在文档中要说的重要一点是“事件有这些方法”。

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