js 函式註解寫法
===

關於js程式註解，不外乎就是使用 單行註解 ```//``` 雙反斜線 和 多行註解 ``` /* */ ``` 。

註解寫的好，在程式上的維護是很重要，要寫的自己看得懂，更要清楚的讓其他工程師也能理解。

註解模板：

/**
 * functionName 函式功能說明。
 *
 * @param  {型態}  傳入變數名稱 - 變數說明。
 * @return {型態}  回傳說明。
 */

function functionName(傳入變數名稱) {  
    // do something...
    return 回傳
}

範例：

/**
 * HelloWord 打招呼訊息傳送是否成功。
 *
 * @param  {String}  greeting - 打招呼的訊息。
 * @return {Boolean} 傳送是否成功。
 */

function HelloWord(greeting) {  
    // do something...
    return true
}

>此篇純屬個人習慣寫法，有其他好的寫法，也歡迎留言分享交流。