关于代码的注释,我自己也是很少写,但是时间一长,连自己都要看很久才知道啥意思,要让别人看明白,更是耗费时间了。

为什么写代码不写注释,主要原因还是因为懒,懒得思考怎么写。不过今天发现一个 VSCode 的插件,可以让 AI 帮你写注释了,写的清清楚楚明明白白。

只要选中函数代码,然后按一个快捷键就会自动生成该方法的注释,可用来生成函数文档。

看下效果
from typing import List
def daily_avg(temps: List[float]) -> float:
    return sum(temperatures)/len(temperatures)

比如上面这样的函数,生成的注释效果如下:

from typing import List

def daily_avg(temps: List[float]) -> float:
    """
    Given a list of temperatures, return the average of the temperatures
    
    :param temps: a list of floats
    :type temps: List[float]
    :return: The average of the temperatures.
    """
    return sum(temperatures)/len(temperatures)

看来 AI 完全知道你在写什么,有点可怕,不过总比让我自己写好,还要考虑怎么翻译成英文,哈哈。

快捷键
  • Windows 和 Linux :Ctrl + Alt + .

  • Mac:⌘ + .

安装方法

浏览器只要打开这个链接 AI Doc Writer[1],然后点击 install 就可以安装到 VSCode 了。

其他

它支持多种语言 JS、TS、Java、Python、PHP 等,有 VScode、IntelliJ 等插件版本,还可以在线试用[2]

最后的话

点击「工具」话题,探索更多好用的编程工具,如果觉得有用,请点个在看分享给需要的朋友,感谢支持。

4f37bd66552a0dcc693d5649fbb99cd9.png

参考资料

[1]

AI Doc Writer: https://marketplace.visualstudio.com/items?itemname=mintlify.document

[2]

在线试用: https://www.docstring.ai

Logo

DAMO开发者矩阵,由阿里巴巴达摩院和中国互联网协会联合发起,致力于探讨最前沿的技术趋势与应用成果,搭建高质量的交流与分享平台,推动技术创新与产业应用链接,围绕“人工智能与新型计算”构建开放共享的开发者生态。

更多推荐