来让人工智能帮你写注释吧,支持 Python
2022-03-16 13:46:22 来源:程序员客栈
关于代码的注释,我自己也是很少写,但是时间一长,连自己都要看很久才知道啥意思,要让别人看明白,更是耗费时间了。
为什么写代码不写注释,主要原因还是因为懒,懒得思考怎么写。不过今天发现一个 VSCode 的插件,可以让 AI 帮你写注释了,写的清清楚楚明明白白。
只要选中函数代码,然后按一个快捷键就会自动生成该方法的注释,可用来生成函数文档。
看下效果fromtypingimportListdefdaily_avg(temps:List[float])->float:returnsum(temperatures)/len(temperatures)
比如上面这样的函数,生成的注释效果如下:
fromtypingimportListdefdaily_avg(temps:List[float])->float:"""Givenalistoftemperatures,returntheaverageofthetemperatures:paramtemps:alistoffloats:typetemps:List[float]:return:Theaverageofthetemperatures."""returnsum(temperatures)/len(temperatures)
看来 AI 完全知道你在写什么,有点可怕,不过总比让我自己写好,还要考虑怎么翻译成英文,哈哈。
快捷键Windows 和 Linux :Ctrl + Alt + .Mac:⌘ + .安装方法浏览器只要打开这个链接 AI Doc Writer[1],然后点击 install就可以安装到 VSCode 了。
其他它支持多种语言 JS、TS、Java、Python、PHP 等,有 VScode、IntelliJ 等插件版本,还可以在线试用[2]。
最后的话点击「工具」话题,探索更多好用的编程工具,如果觉得有用,请点个在看分享给需要的朋友,感谢支持。
参考资料[1]AI Doc Writer: https://marketplace.visualstudio.com/items?itemname=mintlify.document
[2]在线试用: https://www.docstring.ai
相关阅读
-
世界热推荐:今晚7:00直播丨下一个突破...
今晚19:00,Cocos视频号直播马上点击【预约】啦↓↓↓在运营了三年... -
NFT周刊|Magic Eden宣布支持Polygon网...
Block-986在NFT这样的市场,每周都会有相当多项目起起伏伏。在过去... -
环球今亮点!头条观察 | DeFi的兴衰与...
在比特币得到机构关注之后,许多财务专家预测世界将因为加密货币的... -
重新审视合作,体育Crypto的可靠关系才能双赢
Block-987即使在体育Crypto领域,人们的目光仍然集中在FTX上。随着... -
简讯:前端单元测试,更进一步
前端测试@2022如果从2014年Jest的第一个版本发布开始计算,前端开发... -
焦点热讯:刘强东这波操作秀
近日,刘强东发布京东全员信,信中提到:自2023年1月1日起,逐步为...