python文档字符串_结构化的python文档字符串,对IDE友好

在PHP中,我习惯了PHPdoc语法：

/** Do something useful

@param first Primary data

@return int

@throws BadException

function($first){ ...

—简短有用的参考：当您只需要记住“那是什么？”时,非常方便,尤其是对于第三方库.另外,所有IDE都可以在弹出提示中显示此内容.

似乎Python中没有约定：只是纯文本.它描述得很好,但是要消化就太长了.

好吧,随它去吧.但是在我的应用程序中,我不想使用大量的纯文本.

有什么知名的约定可以遵循吗？以及如何记录类属性？尤其欢迎PyCharm IDE食谱:)

在Python3中,功能注释为PEP 3107.这对于2.x(特别是2.6)没有用

还为reStructuredText提供了PEP 0287：花哨的但仍未结构化.

解决方法:

numpydoc标准是基于reStructuredText(在python生态系统中为标准)定义的,并且具有Sphinx集成.为PyCharm编写一个可以消化numpydoc的插件应该相对简单.

标签：python-2-x,docstring,python

来源： https://codeday.me/bug/20191208/2094714.html

python文档字符串_结构化的python文档字符串,对IDE友好相关推荐

文盾信息非结构化数据安全解决方案，高效防护企业文档安全
随着移动互联网的应用发展,移动互联网办公.智能化应用越来越广泛,非结构化数据(办公文档.文本.文件.图片等)在企事业数据占比高达80%及以上,且这些数据每年仍按指数增长60%,在数据爆炸式增长的当下, ...
做结构化怎样选择文档类型
有朋友问,公司决定使用结构化写作的方法来编写公司和设备的文档资料,那应该选择什么文档类型呢?怎样才能够产出有质量的文档? 今天就这个话题,谈谈我的看法. - 1 - 什么是文档类型在结构化写作中,文 ...
【Python】Pandas基础：结构化数据处理
python:Pandas基础:结构化数据处理目录: 文章目录 @[toc] 一 pandas及其重要性二 pandas的数据结构介绍 1 Series 2 DataFrame 3 索引对象三 ...
1.文档数据非结构化
1.用户修改完成文档之后 1.1首先,拿到用户修改过后的文档问:这个时候我们是不是可以拿到用户修改文档之后的字节流文件 1.2然后,这个时候我们使用poi里面的一个方法好像是 XWPFDocum ...
详解非结构化数据（文档）安全管理解决方案
随着互联网技术的日新月异,内容数据逐渐在各行业的业务中占据更重要的地位.日常的业务过程中,需要处理的大量电子文档.图片.音频.视频等,都属于内容数据范畴. 例如,某银行的无人营业网点的远程业务办理中, ...
python开发技术文档范文_程序员编写技术文档的新手指南
这是一篇帮助你给第一个项目写文档的指南. 万事开头难,我希望这份指南能把你引导到正确的道路上. 最后,你应该有一个可以公开发布的项目. 请轻松地阅读完这篇文章,或者简单地把它当作参考. 为什么要写文档 ...
python写word表格_使用表格—— 使用Python读写Office文档之三
本文介绍使用Python在Word中创建一个表格,以及读取表格中的数据. =============================================================== ...
python编辑word书签_小伙发现了Python中编写word文档的库，编辑文字方便多了
新的一年,小编又和大家见面啦.十分开心又和大家分享干货了~ Word文档相信广大的办公室家族并不陌生吧?今天咱们聊聊Python中一个可以用来读写word文档的Python库,编辑文档分分钟的事情哦~ ...
可持久化数据结构加扫描线_结构化光扫描
可持久化数据结构加扫描线 Traditional cameras and image sensors can only obtain two-dimensional images, lacking d ...

python文档字符串_结构化的python文档字符串,对IDE友好

python文档字符串_结构化的python文档字符串,对IDE友好相关推荐

最新文章

热门文章