Python文档化开发注释规范.pdfVIP

下载本文档

7
0
约1.25万字
约 17页
2017-08-28 发布于广东
举报
版权申诉

Python文档化开发注释规范.pdf

1、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。。
2、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击这里二次下载。
3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
4、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
5、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
6、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
7、VIP文档为合作方或网友上传，每下载1次，网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档

1. 11.. 原则在语言要求的地方注释，以标准的注释语法! 我们禁止惊奇！一切规范化到谁都可以准确的猜测出正确的结果最好！(就象 FreeBSD 的组织方式...) 注释说明必要的信息，我们不期望精彩的小说在注释中诞生! 适当的版本标识尽量使用CVS等版本管理系统自动提供的解析因为如果自个儿来写的话难以统一修改适当的设计思路描述适当的算法设计描述 2. 22.. 文档化标签由于开发语言非常丰富，所以选择了最通用和稳定的文档化工具来支持: DoxyGen 是种支持 C++, C, Java, Objective-C, IDL (Corba and Microsoft flavors) 以及 PHP, C# and D 等等语言的文档化工具. 成熟，功能强大,支持广泛甚至于提供了图形界面的管理工具对于所有支持多行注释的语言其实都可以应用 epydoc 是纯Python 实现的 Python 专用文档化工具与Python 结合非常自然，稳定，可扩展 2.1. 22..11.. 基础标签命令仅仅列举我们推荐使用的文档化标签,,进一步的标签命令,,请自行进入相关页面学习, , EpyDoc DoxyGen EEppyyDDoocc注释规范 DDooxxyyGGeenn注释规范 epydoc eeppyyddoocc 解析支持的标签规范目录 py常用命令 py文献信息 py状态信息 py模块信息 py函式信息 py提醒信息 py关联信息 py标签格式 py注释风格 3.py 33..ppyy常用命令讲述基本的常用标签命令 3.1.py 33..11..ppyy文献信息 @author: @@aauutthhoorr::... 作者 @license: @@lliicceennssee::... 版权 @contact: @@ccoonnttaacctt::... 联系 3.2.py 33..22..ppyy状态信息 @version: @@vveerrssiioonn::... 版本推荐使用$Id$ @todo @@ttooddoo[ver]: ... 改进,可以指定针对的版本 3.3.py 33..33..ppyy模块信息 @var @@vvaarrv: ... 模块变量v 说明 @type @@ttyyppeev: ... 模块变量类型v 说明 3.4.py 33..44..ppyy函式信息 @param @@ppaarraammp: ... 参数 p 说明 @type @@ttyyppeev: ... 参数 p 类型说明 @return: @@rreettuurrnn::... 返回值说明 @rtype @@rrttyyppeev: ... 返回值类型说明 3.5.py 33..55..ppyy提醒信息 @note: @@nnoottee::...