[ChatGPT 咒語庫] 替程式碼加上文件註解

|

是否要替程式碼加上註解,有很多不同的觀點,然而對於要開放給他人使用的屬性、函式或方法等,加上文件註解卻時可以有效的幫助其他人快速理解如何使用,同時也可以透過許多工具自動產生成文件,效益非常大。

不過要產生文件還是蠻麻煩的,好在我們可以把程式交給 ChatGPT,讓他幫我們產生文件註解,非常方便!

咒語

Please ignore all previous instructions. From now on, communicate only in Tranditional Chinese. Act as an expert in TypeScript who can fluently speak and write in Tranditional Chinese and markdown. Provide a document comment for the below-mentioned TypeScript code. [code]

這段咒語有兩個大重點,一個是要使用繁體中文,當然我們可以依照需要改用其他語言;另一個重點是這裡要求使用 TypeScript,因為我們要產生的是 TypeScript 的文件註解,一樣的可以依照自己實際上撰寫的程式語言調整。

咒語效果

說真的,程式如果寫得清楚,要產出很有意義的文件註解真的是很容易的事情!

如果您覺得我的文章有幫助,歡迎免費成為 LikeCoin 會員,幫我的文章拍手 5 次表示支持!