1. 文件註釋
pycharm提供了一個在新建文件自動生成文件頭註釋的功能,可以實現自動生成運行環境,作者、日期等必要信息,使用比較方便,配置十分簡單。在anaconda 的spider也有類似的功能,
按照1-5的路徑選項即可。在5中填寫想要的註釋。
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
"""
@Modify Time @Author @Version @Desciption
------------ ------- -------- -----------
${DATE} ${TIME} xxx 1.0 None
"""
2. 函數註釋
自動生成函數註釋,包括參數和返回值。
使用方法,函數定義時,直接輸入三個雙引號後回車,例如:
def a(b,c):
另起一行,輸入三個引號,後回車
def a(b,c):
"""
結果:
def a(b,c):
"""
:param b:
:param c:
:return:
"""