使用DocStrings为python函数添加注释

有过Java或AS3编程经验的码农，有Eclipse或者Flash Builder这样的强大IDE辅助下，不难有这样的经验：

当你想知道一个函数是做什么用的时候，只要将鼠标轻轻抚摸目标函数，就会这样

只要这个函数进行了这样的注释

/**
* 飞行离开新手村，给玩家设置师傅形象
* 非常恶心，不要往下看了
*/		
public function setMaster(npcId:int):void
{
	updateStyle(_style[0],_style[1], _rideId, npcId,_isBlack,hideSuit,_mountAvoid, _isSit, false, _isHeaven);
}

那么python能不能这样呢，答案是肯定的。

使用DocStrings(文档字符串)为python函数添加注释，like this

def docString_test():
  '''This is a DocString test function,

  enjoy it.'''

你可以

print docString_test.__doc__

输出：

This is a DocString test function,

  enjoy it.

也可以

help(docString_test)

输出

Help on function docString_test in module __main__:

docString_test()
    This is a DocString test function,
    
    enjoy it.

这里有一些惯例希望每一个pythoner遵循：

引用自python简明教程：文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。 强烈建议 你在你的函数中使用文档字符串时遵循这个惯例。

enjoy it.