代码风格:
使用4个空格来表示缩进,最好不使用tab,更勿将两者混用
函数间换行至少一行
类之间换行至少两行
字典,列表,元祖中元素应该在逗号前添加一个空格
字典中键后面的冒号:应在值与冒号:之间添加空格,而不是:与键之前间. 比如说: {‘name’:‘tom’}
较长代码(>79字符)使用\换行。换行后新行的起始处应该与前一个分隔符对齐(是参数换行则与左括号对齐
import位于module comments与docstring之后,常量声明之前
如多模块,请分开导入. 像import os, sys是...
分类:
编程语言 时间:
2015-06-22 12:27:12
阅读次数:
143
在使用Python时,一个特性是Python中的文档字符串,文档字符串又称为DocStrings。使用文档字符串可以为我们的模块、类、函数添加说明性文档,使程序更容易被看懂。这好像和其他语言中的注释没什么区别,然而,Python中的文档字符串特殊在于Python提供了相应的方法,可以将这些说明性的文档输出。
假设有如下的函数:
def Test():
'''
| ##@fu...
分类:
编程语言 时间:
2015-03-31 14:52:51
阅读次数:
344
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc.
pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的、也可以生成WEB 页面的,还可以在服务器上以浏览器的方式呈现!...
分类:
编程语言 时间:
2015-03-02 16:54:43
阅读次数:
212
虽然doxygen声称可以同时支持两种风格的python注释,原生的docstring和类似java doc风格的##。但实际对原生的docstring支持并不好。这里介绍了一个开源的doxypypy工具,可以将原生的docstring转换为类java doc风格的##, 从而实现doxygen对python原生docstring的完美支持,同时也自然而然支持使用@tag。...
分类:
编程语言 时间:
2014-08-24 22:21:33
阅读次数:
241
Jedi 是个很棒的python的自动补全插件,可以显示docstring, function arguments and code location.安装步骤:一、安装python的虚拟环境sudo apt-get install python-virtualenv或sudo apt-get in...
分类:
其他好文 时间:
2014-08-08 23:56:46
阅读次数:
1234
例子import urllib2class RedirctHandler(urllib2.HTTPRedirectHandler):"""docstring for RedirctHandler"""def http_error_301(self, req, fp, code, msg, heade...
分类:
编程语言 时间:
2014-07-08 23:44:41
阅读次数:
584
python:“蟒蛇”import py_compile
:编译模块,生成pyc文件,或者pyo文件;python -o -m py_compile hello.pypython 补充: 运算符:in/not
in,成员测试, is/not is,同一性测试,三重引号(docstring)的作...
分类:
编程语言 时间:
2014-05-19 17:02:49
阅读次数:
322
def highlight_element(self, locator):
"""docstring for highlight_element""" self._info("start") element =
self._element_find(...
分类:
Web程序 时间:
2014-04-30 03:28:21
阅读次数:
610