1. 程式人生 > >js筆記十:vscode程式碼提示

js筆記十:vscode程式碼提示

對於開發過程中,如果有函式或屬性提示,可以大大提高效率。對於java,python,C#等語言強型別的編譯型指令碼語言,其對應的IDE都有完備的程式碼。對於C++/C也有比較完善的程式碼提示,而js和lua這種弱型別語法,就很難了。很多僅僅是提供了同文件或同目錄已有關鍵字的程式碼提示。這個也是js開發最頭痛的地方之一。
        在使用vscode開發js,則提供一種辦法,提高程式碼提示的正確率。一、typescript;二、js doc;三、@types
• 對於typescript,則是增強js的型別。損失一點js的自由度,提搞一些開發效率。
• Js doc真的很強大,配合vscode,可以完整的顯示出來。這裡有比較完整的js doc的資料http://www.css88.com/doc/jsdoc/
• @types則是新vscode程式碼提示庫,有很多主流的庫,如node本身的,還有lodash等。https://www.npmjs.com/~types


這裡重點是程式碼中的js doc

一、 安裝js doc外掛。在vscode的外掛管理,搜尋Add jsdoc comments,然後安裝就可以。



二、插入js doc。
• 將游標移到要插入註釋的類或函式名上面,按F1或ctrl+shift+p,選擇Add jsdoc comments,就會跟據當前引數列表,預生成註釋,然後我們再完善它就可以了。
• 另外一種辦法,就是在要插入註釋的類或函式前一行,輸入/**,就會有程式碼提示是否要生成註釋,如下圖:


三、填寫註釋
如下圖示例:


將游標移到函式名上面,就會有代提示了


在使用的地方,也會有程式碼提示了



關於:@types
對於@types其實之前,還有一個typings,相對來說,沒有@types支援的好
Typings https://www.npmjs.com/package/typings

@types https://www.npmjs.com/~types

歷史筆記: