python小技巧: 对象字段文档注释, 一行分拆多行

对象字段文档注释

python类和函数的文档注释比较常用, 只需要在类和函数下面增加'''即可, 就可以在引用的地方查看注释内容了.
但是对于类的字段, 怎么增加注释呢? 只需要像下面即可:

class TradeRecordData:	#H.Read
    '''一次完整的交易记录. 包括买入及卖出'''	#H.Read
    def __init__(self):	#H.Read
        self.code = ''	#H.Read
        '''股票代码'''	#H.Read
        self.buy_date = ''	#H.Read
        '''购买日期'''	#H.Read
        self.sell_date = ''	#H.Read
        '''卖出时间'''	#H.Read
        self.buy_price = ''	#H.Read
        '''买入均价'''	#H.Read
        self.sell_price = ''	#H.Read
        '''卖出价格'''	#H.Read
        self.volume = 0	#H.Read
        '''股票数量'''	#H.Read
        self.pl = 0.0	#H.Read
        '''赢亏比例'''	#H.Read

在vscode里面就可以显示对应字段的注释信息了:

• 补充: 对于全局变量也可以采用同样的文档注释.

分拆多行

比如:

a= 'abc''def'
# 可以这样写
a = 'abc'\
	 'def'
# 还有一种我认为更好的写法
a = (
	'abc'
	'def'
)

()符号可以把里面的多行内容视为一行代码, 如下所示:

a=10
b=11
c=(
    a
    +
    b
)
print(c)  # 输出21