Tworzenie organizacji podobnej do przestrzeni nazw w bibliotece skryptów Google Apps

Question

Szukałem w tworzeniu zestawu narzędzi za pomocą skryptu aplikacji Google. Problem polega na tym, że o ile mogę powiedzieć, pozwala to tylko na jeden poziom organizacji. Możesz utworzyć bibliotekę o nazwie Stoper i wywołać metody Stopwatch.start() i Stopwatch.stop(), co jest całkiem fajne.

Co jednak miałem na myśli to coś bardziej przypominającego Utils.Stopwatch(). Start() i Utils.Timer.start() itd. Myślę, że jest to z pewnością możliwe w javascript, ale żeby dalej łamać Apps Script autouzupełnianie funkcja musi zostać dodana w określonym formacie. Poniżej znajduje się przykład wykonania błędu (daje błąd), ale może zaoszczędzić trochę czasu. Jest oparty na artykule this.

/** 
* A stopwatch object. 
* @return {Object} The stopwatch methods 
*/ 
function Stopwatch() 
{ 
    var current; 

    /** 
    * Stop the stopwatch. 
    * @param {Time} time in miliseconds 
    */ 
    function timeInSeconds_(time) 
    { 
    return time/1000; 
    } 

    return 
    { 
     /** 
     * Start the stopwatch. 
     */ 
     start: function() 
     { 
     var time = new Date().getTime(); 
     current = timeInSeconds_(time); 
     }, 

     /** 
     * Stop the stopwatch. 
     * @return {decimal} time passed since calling 
     * start (in seconds) 
     */ 
     stop: function() 
     { 
     var time = new Date().getTime(); 
     var difference = timeInSeconds_(time) - this.current; 
     return difference.toFixed(3); 
     } 
    }; 
} 

Dzięki

Answer 1

Można składać wnioski fabularnych tutaj:

http://code.google.com/p/google-apps-script-issues/issues/list

Answer 2

Co za pomocą OO?

Wygląda bardzo dobrze zorganizowany i łatwy do udokumentowania.

/** 
* A stopwatch Class. 
* 
* @constructor 
*/ 
function Stopwatch() { 
    this.current = new Date().getTime(); 
} 

/** 
* Starts the stopwatch 
*/ 
Stopwatch.prototype.start = function(){ 
    this.current = new Date().getTime(); 
}; 

/** 
* Stops the stopwatch 
* 
* @return {number} Number of seconds since Stopwatch was started 
*/ 
Stopwatch.prototype.stop = function(){ 
    return ((new Date().getTime()) - this.current)/1000; 
}; 

Przykład. W przypadku, gdy twoja biblioteka jest importowana jako Utils.

var s = new Utils.Stopwatch(); 
s.start(); 

// (...) 

Logger.log(s.stop()); 

PS: To jest nietestowany kod.

Jako efekt uboczny można mieć wiele stoperami, każdy utrzymując swój własny zmienna lokalna current

UPDATE

Chociaż jest prawidłowo udokumentowane następujące JSDoc obecnie nie uzupełni metody z Google Skrypt aplikacji.

Answer 3

To nie działa, ale zespół wie o tym. Do tego czasu będziesz musiał udokumentować swoje biblioteki w witrynie. Sądzę, że możesz umieścić te metody w opisie. To naprawdę świetny początek dla nowej usługi, ale byłem z tobą około 5 minut i już chciałem więcej. ;)

Answer 4

Dopóki taka funkcja nie zostanie natywnie obsługiwana przez Google, można zdefiniować puste funkcje z adnotacjami na tym samym poziomie, co funkcja konstruktora. Możesz nawet zachować oryginalną strukturę kodu. Umożliwi to automatyczne uzupełnianie w edytorze. Dodatkowo otrzymasz automatycznie wygenerowaną dokumentację swojej biblioteki, np. https://script.google.com/macros/library/versions/d/YOUR_PROJECT_KEY

Przykład:

/** 
* Constructor. 
* @constructor 
* @param {String} apiKey Doxument API key 
* @param {String} apiToken Doxument API token 
*/  
function DoxumentApi(apiKey, apiToken) { 
    // public api 
    return { 
     get: function(id, params) { 
      var httpResponse = execute('/docs/' + id + '.json?' + buildQuery(params)); 
      return parse(httpResponse); 
     } 
    } 
} 

/** 
* Get document record. 
* @param {String} id document id 
* @param {Object=} params optional. extra get params 
* @return {Object} Document object 
*/  
function get(id, params) {}