利用PyCharm生成类似于Pytorch的高质量注释

在学习pytorch时,无意间发现pytorch的注释写的非常详细。在pycharm中,输入函数名后直接按Ctrl+Q即可快速打开注释窗口。随便贴几个感受一下: 可以看到,不仅可以在注释中添加参数表格、说明、examples,还可以插入图片、超链接和类型等信息。 其实他们是用了谷歌的python docstring format。只需要在pycharm中稍微设置一下,便可以自动生成这种注释模板。
相关文章
相关标签/搜索