idea设置方法注释模板,idea如何文档注释

　　优雅的注释有助于理解代码，便于与人开发，提高效率。但是如果没有自动标注，写标注就要费时费力。

　　本文介绍了在pyCharm中注释方法的两种方式：Docstring格式和Live模板。

　　1 Docstring格式1.1 DocString格式添加方法注意事项Docstring格式可以通过以下路径设置，包括Plain、Epytext、reStructuredText、Numpy、Google五种样式。

　　文件-设置-工具- Python集成工具-文档字符串-文档字符串格式

　　要使用它，在方法名下面输入三个双(单)引号，回车，就会自动生成。这五种样式如下：

　　DEF DOCStrings _ func _ plain(Parm _ a，parm _ b，Parm _ c): plain style DEF DOCStrings _ func _ epytext(Parm _ a，parm _ b，Parm _ c): epytext style @ param Parm _ a:parameter a @ param parm_b:param Parm _ c:param c @ return:result a DEF DOCStrings _ func _ reformated text(Parm _ a，Parm _ b， Parm _ c): 重构的文本样式：param parm_a:参数a :param parm_b:参数b :param parm_c:参数c:返回：结果a def docs strings _ func _ NumPy(Parm _ a，parm_b，parm_c) : NumPy样式参数-parm _ a:参数a parm_b:参数b parm_c:参数a返回-result _ a:结果a def docs strings _ func _ Google(Parm _ a，parm _ b parm _ c): Google style Args:parm _ a:parameter a parm _ b:parameter b parm _ c:parameter c返回：result_a result a 1.2 Docstring格式添加参数类型注释Python是一种动态语言，使用动态类型化，即在运行时确定数据类型。借助pyCharm的方法类型检查功能，对于一些类型已经确定的参数，加上类型注释，可以在编写代码时提前发现错误。

　　下面的代码第一行没有添加参数类型注释，第二行添加了参数类型注释，所以pyCharm可以根据方法对应的docstrings提前判断输入参数类型的问题，并给出正确的类型提示。

　　pyCharm中打开的插入类型占位符的注释路径如下：

　　文件-设置-编辑器-常规-智能键-在文档注释存根中插入类型占位符

　　打开后，使用Docstring格式添加方法注释，会出现一个类型占位符。

　　对于reStructuredText样式，参数类型可以与参数描述写在同一行，也可以单独写。

　　Epytext对格式的注释(Ctrl Q可以通过快捷键查看)如下：

　　添加了参数类型的每个方法的注释如下：

　　def docstrings _ func _ Epytext _ type(parm _ a，parm_b，parm_c): Epytext style-param type @ param parm _ a:parameter a @ type parm _ a:int @ param parm _ b:parameter b @ type parm _ b:str @ param parm _ c:parameter c @ type parm _ c:bool @ return:result _ a result a @ rtype:int def docs strings _ func _ re structured text _ type(parm _ a，parm _ c parm _ c): restructured text style-param type:param parm _ a:param a:type parm _ a:int:param parm_b:param b:str:param parm _ c:param c:bool:retire N:result _ a result a:rtype:int defdocs strings _ func _ restructured text _ type _ 2(parm _ a，parm _ b， parm_c): 结构化文本样式-参数类型与参数描述在同一行：param int parm_a:参数a :param str parm_b:参数b :param bool parm_c:参数c :return: result_a结果a:rtype:int de f doc strings _ func _ NumPy _ type(parm _ a，parm_b，parm_c) : NumPy样式-参数类型参数-parm _ a: int参数a parm_b: str参数b parm_c parm _ c): Google style-parameter type Args:parm _ A(int):parameter A parm _ b(str):parameter b parm _ c(bool):parameter c Returns:result _ A(int):result A 2 Live Templates DocString格式可以自动打印格式DocString，但是不能添加创建人、创建时间、修改人、修改时间和版权声明；有些规范定义了这些元素写在文件的头中，但是对于同一个文件的协同开发，还是需要在每个方法中加入这些元素，这样会更清晰。

　　可以通过pyCharm的Live Templates自定义模板来实现。

　　在实时模板中设置路径，如下所示：

　　文件-设置-编辑器-实时模板

　　添加如下：

　　进入直播模板设置页面，点击右边的加号，添加模板组，然后添加直播模板。在底部添加缩写和描述。

　　3.在下面添加适用的(适用的语言范围)。

　　4.在模板文本中添加以下模板代码

　　6.为了方便使用注释，还可以添加更新时间和当前时间。

　　7.在方法下面输入配置的缩写，可以使用Tab或Enter自动生成注释。参见下面的代码。

　　使用实时模板添加方法注释有一个问题。方法参数不能自动生成，所以需要从Docstring格式的方法注释中复制。尚未找到用于解析实时模板中的方法参数的pyCharm内置方法；比如IDEA中解析方法参数的内置方法methodName()，解析方法返回参数类型的内置方法methodReturnType()，结合groovy脚本的method name()(" def result= ；def params="${_1} "。replaceAll([\\[\\]\\s]， )。拆分(，)。to list()；for(I=0；I params . size()；I){ result= * @ param params[I]((I params . size()-1)？\ n : )}；Result ，methodparameters())，可以实现解析Live模板中的方法参数，并以格式输出。

　　不知道pyCharm是否支持标准的Docstring格式但不设置这个方法？找了半天也没找到解决办法，期待大家的评论。

　　注释代码如下：

　　def doc strings _ func _ Live _ Templates(parm _ a，parm_b，parm_c): 实时模板自定义参数-返回-:作者：dkjkls:创建时间：2019/3/31 16:55:博客：https://blog.csdn.net/dkjkls版权所有2019年，丹麦克朗集团保留所有权利 def doc strings _ func _ Live _ Templates _ parm _ type(parm _ a，parm_b，parm_c): Live模板自定义参数从文档字符串_函数_重构文本复制，暂未找到live _模板中解析方法参数的路径内置方法想法解析方法参数的内置方法方法名(),解析方法返回参数类型的内置方法methodReturnType()方法名()结合groovy脚本( def result= )；def params=；返回结果，methodParameters())，可实现在live _模板中解析方法参数并按格式输出参数-:参数int参数_a:参数参数潜艇用热中子反应堆（submarine thermal reactor的缩写）参数_b:参数乙：param bool参数_c:参数c返回-:返回：结果_a结果a :rtype: int:作者：dkjkls:创建时间：2019/3/31 16:55:博客：https://blog.csdn.net/dkjkls版权所有2019年，丹麦克朗集团保留所有权利参考：https://www。喷气大脑。使用-doc字符串来指定类型。超文本标记语言

　　https://www。喷气大脑。com/help/py charm/settings-智能钥匙。超文本标记语言

　　-文档信息-

　　署名(BY) :dkjkls(dkj卡洛斯)

　　文章出处：http://blog.csdn.net/dkjkls

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。

相关文章阅读