pycharm使用google的方法注释

于 2024-01-12 08:56:32 发布
阅读量747 收藏 10
点赞数 11
文章标签： pycharm ide python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42317631/article/details/135543434
版权
本文介绍了如何在PyCharm的中文版本中设置工具以支持Google风格的文档字符串（Docstring），通过在方法内部使用特定符号生成带参数的注释。
摘要由CSDN通过智能技术生成

设置中找到
Tools > Python Integrated Tools
选择Docstring format为Google

笔者的pycharm为中文版：

设置好之后在方法内部敲击"""(也就是三下双引号)，可以产生一个带有参数的注释，如下所示：

weixin_42317631
关注
零基础入门篇③ PyCharm使用指南(个性化设置、开发必备插件、常用快捷键)
hacker707的博客
04-07 3472
Python从入门到精通👉零基础入门篇③
〖Python零基础入门篇⑤〗- Pycharm常用的快捷键
易编橙 · 终身成长社群，相遇已是上上签！
02-19 4万+
作为程序员，在开发过程中会经常使用快捷键以提高工作效率。在这里主要介绍一些常用快捷键，以及如何编辑更新这些快捷键等相关的知识。
Python 编程规范
waterforest的专栏
05-07 9403
Python风格规范 分号 Tip 不要在行尾加分号, 也不要用分号将两条命令放在同一行. 行长度 Tip 每行不超过80个字符 例外: 长的导入模块语句注释里的URL 不要使用反斜杠连接行. Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额
Google Python代码风格指南
算法channel
03-10 443
谷歌Python代码风格指南 中文翻译你好，我是zhenguo这是关注我的一位粉丝翻译的Google Python代码风格指南，很全面。可以作为公司的code review 标准，也可以作...
pycharm代码注释支持google风格
QuantumEnergy's blog
05-08 9842
在设置中找到 Tools > Python Integrated Tools 选择Docstring format为Google
Python Google风格注释详解
复现的博客
11-03 886
Google风格注释是Python代码注释的一种标准化格式，它提供了一种规范的注释格式，使得代码更加易读、易于维护。Google风格注释使用三个双引号来包围注释内容，并按照一定规范编写。在注释中使用动词短语来描述函数的行为，并使用被动语态。在注释中使用正确的标点符号和缩进，使得注释易于阅读和理解。通过使用Google风格注释，我们可以为代码提供清晰的文档和说明，使得代码更加易读、易于维护。
Python 代码风格指南谷歌版
算法channel
04-24 538
非常感谢我们的忠实读者shendeguize，在后台留言告诉我，已经翻译了《谷歌Python代码风格指南》，大家这样相互帮助，感觉真是太好。Update: 2020.01.31Tra...
pycharm注释跨界见
05-11
类注释：在类定义的第一行使用三引号注释，用于记录类的功能、属性和方法等信息。可以使用 Google 风格或 NumPy 风格的类注释。 文档注释：使用 Sphinx 工具生成的文档注释，可以生成项目的文档。 在编写代码时，...
Pycharm+selenium+chrome环境配置
m0_61690002的博客
06-02 2341
Pycharm+selenium+chrome环境配置
【Python基础学习笔记day05】pycharm注释的作用+单行注释（行注释）+多行注释（块注释）+关于代码规范
汪雯琦的博客
01-21 802
注释 目标 注释的作用 单行注释（行注释） 多行注释（块注释） 01. 注释的作用 使用用自己熟悉的语言，在程序中对某些代码进行标注说明，增强程序的可读性 02. 单行注释(行注释) 以 # 开头，# 右边的所有东西都被当做说明文字，而不是真正要执行的程序，只起到辅助说明作用 示例代码如下： # 这是第一个单行注释 print("hello python") 为了保证代码的可读性...
【Python开发手册】深入剖析Google Python开发规范：规范Python注释写作
Zeeland的博客
04-16 1289
在Python编程中，注释的作用不仅仅是解释函数或代码块的作用，还可以提高可读性、可维护性和表达代码意图的清晰性。正确书写Python注释，既是程序员的编程规范，更是提高代码质量的必要措施。因此，本文总结了Python注释的写法规范和注意事项，以及如何利用Pycharm代码模板快速生成规范注释的方法，帮助广大程序员提高代码质量和效率。
python常用注释风格-Google
最新发布
LinWaishua的博客
11-24 198
主要有PEP8 规范，PEP 257，以及Google的注释风格。PEP8是官方的、基础性的规范（略略略）。PEP257是Python Enhancement Proposal（增强规范）的一部分，专门针对文档字符串。
Python编程代码规范（Google Style）
ZONGXP的博客
07-23 3971
原文：https://www.jianshu.com/p/8b6c425b65a6 在编程过程中，要遵循一定的规则，包括函数命名、变量命名、代码注释等，虽然不遵循也能使代码运行成功，但优秀的、整洁的代码必定是遵循潜移默化的一些规则，这样别人阅读起来也会很轻松，否则将来甚至自己也看不懂。为了能及时发现问题，可使用python的IDLE来编写，如pycharm等工具遵循PEP 8规则，会自动发现并提...
pycharm设置Googl文档风格
real_ilin的博客
03-21 362
pycharm设置默认注释
⛄
11-25 598
打开pycharm，file ---Settings---Editor---file and code templats----Python Scripts： # -*- coding: utf-8 -*- # __author__:Muyao # ${DATE} ${TIME} font：设置代码字体大小
pyCharm中添加方法注释（Docstring format & Live Templates）
热门推荐
dkjkls的博客
03-31 5万+
版权声明：本文为博主原创文章，未经博主允许不得转载。 优雅规范的注释有助于对代码理解，易于与人合作开发，提高效率。但若没有自动化的注释会让写注释耗时耗力。 注释中的要素包括：功能和用途简介、参数、返回值、创建人、创建时间、修改人、修改时间、版权声明、异常抛出。 本文介绍在 pyCharm 中使用两种方式进行方法的注释：Docstring format 和 Live Templates。 1 D...
pycharm 修改默认的注释风格（reStructuredText风格、Google风格、Numpy风格）
呆萌的代Ma
05-02 2750
位置是：Preferences | Tools | Python Integrated Tools 也可以在设置中直接搜索：Docstring format
pycharm不能使用谷歌浏览器，设置自己喜欢的浏览器运行前端代码（￥8）
tiefen.wang的博客
01-03 1万+
打开pycharm，点击File，找到settings，点击即可 找到Tools，然后第一个Web Browsers(点击即可) 点击Custom path(自定义路径)我用的是QQ浏览器 我用的QQ浏览器的路径，你们可以右键属性找到目标位置（不用双引号） 把下面的Show browser popup in the editor(浏览器显示在编辑框右上角)点击ok即可 设置好了，可以在p...
python风格规范_google的Python风格规范
weixin_32823993的博客
02-11 136
分号Tip不要在行尾加分号, 也不要用分号将两条命令放在同一行.行长度Tip每行不超过80个字符例外:长的导入模块语句注释里的URL不要使用反斜杠连接行.Python会将圆括号, 中括号和花括号中的行隐式的连接起来, 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号.Yes: foo_bar(self, width, height, color='black', des...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值