科技行者

行者学院 转型私董会 科技行者专题报道 网红大战科技行者

知识库

知识库 安全导航

至顶网软件频道应用软件 你有,我有,Python也有

你有,我有,Python也有

  • 扫一扫
    分享文章到微信

  • 扫一扫
    关注官方公众号
    至顶头条

Java和.net环境下都有工具可以把代码中的注释提取出来,python在这方面也不示弱,pydoc就可以作到这一点。

作者:dahuzizyd 来源:CSDN 2008年5月17日

关键字: java python 软件

  • 评论
  • 分享微博
  • 分享邮件

Java.net环境下都有工具可以把代码中的注释提取出来,python在这方面也不示弱,pydoc就可以作到这一点。

Pydoc是从python2.1版本就加入到其标准库中的。当我们在命令行解释器中调用help()命令时,就使用他来在控制台上显示代码中的注释。我们也可以使用他来把module中的注释提取出来,按照一定的组织方式生成该module的说明文档,包括类,方法等。


Pydoc
的源代码可以在python的安装目录的lib文件夹内找到(我安装的是2.4)。

使用pydoc时,你可以使用-w参数来对指定的模块生成一个Html文档。

例如:pydoc.py –w string

这样就会在当前目录生成一个对应的HTML文件。


如果要给某个目录下的所有模块生成
HTML文件。可以使用:

pydoc.py –w Z:\


你还可以使用
-p参数来启动一个本地站点,这样你就可以在浏览器中查看modules的说明了,例如:

pydoc -p 1234 -w z:\

执行完此命令,在浏览器中输入地址:http://localhost:1234/,就可以查看modules的说明了。怎么样,生成的文档还不错把。
如果你对生成的效果不满意,可以自己打开
pydoc.py文件来修改自己喜欢的样式。

另外还有一个doc生成工具:pythondoc

 

VS.net中的代码折叠是一项很不错的功能,特别是代码比较长的时候,可以是代码阅读起来容易些。在python中虽然默认的IDLE没有这个功能,但是pythonwin这个IDE有这功能,在编辑.py文件时,可以看到在代码编辑器左边有一栏,在“class”,“def”等关键字旁有小横杠样的标记,点击后会变成加号,同时折叠这部分的代码,不单是“class”,“def”等关键字,甚至连ifelsefor等都可以折叠。


这让我不由想到以前看
delphi代码时的痛苦,代码一多,阅读起来只能用上下翻飞来形容。而这样的一个功能,pythonwin这样的由个人写的IDE都实现了,可是borland却一直没有给delphi加上,让人感慨python的活力的同时,为borland感到惋惜。

    • 评论
    • 分享微博
    • 分享邮件
    邮件订阅

    如果您非常迫切的想了解IT领域最新产品与技术信息,那么订阅至顶网技术邮件将是您的最佳途径之一。

    重磅专题
    往期文章
    最新文章