определение класса для объектов Javascript в документации - PullRequest
Новая
       4

определение класса для объектов Javascript в документации

0 голосов
/ 16 декабря 2011

Я разрабатываю библиотеку 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 Ответ

1 голос
/ 16 декабря 2011

Вы, вероятно, ищете термин "пространство имен".

Тебе действительно не стоит так сильно беспокоиться о правильном слове. Все они слишком расплывчаты и имеют совершенно разные значения - это несколько разных значений в субкультурах JavaScript.

Важно отметить, что в документации «Событие использует эти методы».

Я хочу увидеть сигнатуры методов, я хочу увидеть высокоуровневое описание того, что они делают, и я хочу увидеть пример.

...