本文介绍了PyCharm和VSCode在编写代码时的注释方式。PyCharm的头部、函数和类注释需要手动配置，而VSCode提供了更高度自定义的头部注释选项。作者分享了在PyCharm中设置模板的步骤，并指出函数注释遵循Google风格。对于VSCode，头部注释的自定义程度更高，但具体内容未详述。
在公司写代码的时候，搞了个头部注释和函数注释。现在记录一下。
总结
vscode的头部注释自定义程度更高一些，pycharm属于可以使用的范畴。pycharm需要自己手动定义头部、类的注释，函数的注释选择使用google风格的注释。
pycharm
头部注释
在preferences里，editor有个live templates，在里面新建组，命名为comments，新建header_header（头部注释），内容为：
##########################################################
#
# Author: hejiale
# Date: $DATE$
#
##########################################################
$END$
填完后编辑variable，如下图：
即可
函数注释
使用google风格的函数注释，在preferences的tools里，如下图：
类注释
同头部注释，在preferences里添加：
"""Summary of class here.
Longer class information....
Attributes:
likes_spam: A boolean indicating if we like SPAM or not.
eggs: An integer count of the eggs we have laid.
"""
$END$
后续根据class的args，将上面的attributes改为相应的args
vscode
tbc
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
