## JSDoc 腳本注釋（JSDocScript Comments） 如果你希望自定義腳本具有代碼自動補全并可以在腳本編輯器中自動提示所需的參數等，就需要添加一些[JSDoc](http://www.oracle.com/technetwork/articles/java/index-137868.html)格式的腳本注釋。如果你導入了老版本的項目，則可能在一些淘汰的函數上方見過這樣的內容  一個標準的腳本頭文件注釋的格式應該包含函數的描述、函數名，并列出該函數所需要的不同參數，務必保證每一行的開頭是三個反斜杠“///”，這會告知GMS2此處應注釋為JSDoc格式。不同的內容前還應給予標識符（以@開頭），標識符格式如下 | 標識符 | 含義 | |---|---| | @function / @func | 完整的函數名及傳參格式，如："my_script(x, y, colour)". | | @description / @desc | 對當前函數功能的大致描述 | | @param / @arg / @argument |以"{}"包圍的參數類型(可選),參數名稱及簡短的描述（以空格間隔） | 要具體了解使用的方法，我們以下面這個例子來進行說明： ~~~ // is_same_object(id, object) if argument0.object_index == argument1 ???{ ???return true; ???} else return false; ~~~ 上面這個腳本的工作就是檢查一個實例是否與傳入的對象的object_index一致，我們像下面這樣來調用這個腳本函數: ~~~ if is_same_object(id, obj_Player) ???{ ???instance_destroy() ???} ~~~ 但是現在這樣寫進腳本里，當你調用的時候編輯器無法給你提供自動補全以及參數提示，因此我們需要添加一個JSDoc的注釋，如下所示： ~~~ /// @function is_same_object(id, object) /// @description Compare an instance object index with that of another. /// @param {real} instance_id The unique instance ID value of the instance to check. /// @param {real} object_index The object index to be checked against. if argument0.object_index == argument1 ???{ ???return true; ???} else return false; ~~~ 現在，無論我們在何處調用這個腳本時，都會看到如下的自動補全和參數提示了。  在上面這個圖片中，第一張圖顯示了代碼自動補全的功能，第二張圖則顯示了編輯器底部的參數助手是如何運作的。要注意，當你使用"@function"標識符時，在IDE中會提示與資源樹中腳本名稱一致的名稱，因此你可以在資源樹中把腳本命名為A，然后在@function中定義成B，IDE會自動把兩者判斷為同一個腳本的不同別名，但是只有@function定義的名稱具有自動補全功能 > 譯者：我個人測試@function好像沒啥用，只要定義了@param以后就會有自動補全了，自動補全的函數名就是腳本名稱，@function中我定義了另一個名字并沒有在自動補全中出現，如果有朋友成功了可以告知 > --: 注于2018/01/24 另外要注意，默認情況下，在這里定義的@param的參數類型以及描述都不會在狀態欄中顯示出來，如有需要則去設置項中單獨設置——[語言設置](語言設置.md)