python中的注释有哪几种,python 类注释规范

  python中的注释有哪几种,python 类注释规范

  计算机编程语言类和方法注释规范

  注释风格重构文本(PyCharm默认)def func(path,field_storage,temporary): 基本描述详细描述:参数路径:要包装的文件的路径:type path:str:param field _ storage:The:class:` File storage `要包装的实例:type field _ storage:File storage:param temporary:当文件实例被析构时是否删除文件:类型临时:布尔值:返回:缓冲的可写文件描述符:rtype:buffered file storage pass NumPy def func(path,field _ storage,临时): 基本描述详细描述参数-路径:字符串要包装的文件的路径field _ storage:File storage:class:` File storage ` instance to wrap temporary:bool当文件实例被析构时是否删除文件returns-bufferedfilestoration一个缓冲的可写文件描述符 通过谷歌(官方推荐)def func(path,field_storage,temporary): 基本描述详细描述参数:路径(字符串):要包装的文件的路径field _ storage(文件存储):class:` File storage `要包装的临时实例(bool):当文件实例被析构时是否删除文件返回:bufferedfilestoration:一个缓冲的可写文件描述符 通过风格特点适用重组文本用冒号分隔皮查姆默认NumPy用下划线分隔倾向垂直,长而深的文档谷歌用缩进分隔倾向水平,短而简单的文档狮身人面像对NumPy和谷歌风格的对比,英文不好可以参考中文版

  小技巧在皮查姆中转换成曲线可快速查看注释

  参考文献计算机编程语言风格规范—谷歌开源项目风格指南狮身人面像入门——快速生成计算机编程语言文档

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

留言与评论(共有 条评论)
   
验证码: