中文字幕二区_国产精品免费在线观看_黄色网站观看_人人草人人澡_日本真实娇小xxxx

參數

1. 簡單類型
   簡單的類型的參數可以直接在函數參數定義中注釋說明。
   function(/*String*/ foo, /*int*/ bar)...
2. 可變類型參數
   下面是幾個修飾符供參考：
• ? 可選參數
• ... 說面參數范圍不確定
• [] 數組
  function(/*String?*/ foo, /*int...*/ bar,
  /*String[]*/ baz)...
3. 全局參數描述
   如果你想增加一個描述，你可以將它們移至初始化塊。
   基本信息格式為： *關鍵字* 描述字段 （ *key* Descriptive sentence）
   參數和變量的格式為： *關鍵字* ~*類型*~ 描述字段 （ *key* ~*type*~ Descriptive sentence）
   注： *關鍵字* 和 ~*類型*~ 可以使用任何字母和數字表述。
   function (foo, bar) {
       // foo: String
       //  used for being the first parameter
       // bar: int
       //  used for being the second parameter
   }

變量

由于實例變量、原型變量和外部變量的聲明是一致的，所以有很多的方法聲明、修改變量。具體的如何定義和定位應在變量最先出現(xiàn)的位置指明變量的名稱、類型、作用域等信息。

function foo() {
    // myString: String
    // times: int
    //  How many times to print myString
    // separator: String
    //  What to print out in between myString*
    this.myString = "placeholder text";
    this.times = 5;
}

foo.prototype.setString = function (myString) {
    this.myString = myString;
}

foo.prototype.toString = function() {
    for(int i = 0; i < this.times; i++) {
     dojo.debug(this.myString);
     dojo.debug(foo.separator);
 }
}
foo.separator = "=====";

對象中的變量注釋

應使用和對象值和方法一致的標注方式，比如在他們聲明的時候：

{
    // key: String
    //  A simple value
    key: "value",
    // key2: String
    //  Another simple value
}

返回值

因為函數可以同時返回多個不同（類型）的值，所以應每個返回值之后加入返回類型的注釋。注釋在行內注釋即可，如果所有的返回值為同一類型，則指明返回的類型；如為多個不同的返回值，則標注返回類型為"mixed"。

function() {
 if (arguments.length) {
  return "You passed argument(s)"; // String
 } else {
        return false; // Boolean
    }
}

偽代碼（有待討論）

有時候您需要在函數或者類中添加對于此函數和類的功能性流程描述。如果您打算這樣做，您可以使用 /*======== （= 字符最好出現(xiàn) 5 次或者更多），這樣做的好處就是可以不用將這些東西加入代碼（譯注：原作者的意思可能為代碼管理系統(tǒng)）。

這樣看起來在 /*===== 和 =====*/ 會有非常長的一段注釋，等待功能調整完畢以后就可以考慮是否刪除。

/*=====
module.pseudo.kwArgs = {
 // url: String
    //  The location of the file
    url: "",
    // mimeType: String
    //  text/html, text/xml, etc
    mimeType: ""
}
=====*/

function(/*module.pseudo.kwArgs*/ kwArgs){
    dojo.debug(kwArgs.url);
 dojo.debug(kwArgs.mimeType);
}

本文鏈接：http://www.95time.cn/tech/program/2007/5103.asp　

出處：藍色理想
責任編輯：moby

上一頁 Dojo Javascript 編程規(guī)范 [4] 下一頁

◎進入論壇網絡編程版塊參加討論