python写注释 - 腾讯云开发者社区 - 腾讯云

开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

写注释和不写注释，哪种更适应职场？

如果代码缺乏注释，变量命名含糊（如 a、b），新加入的团队成员或接手代码的开发者可能需要花费大量时间去“解谜”。...清晰的注释和规范的命名（如 calculateTotalPrice 而非 calc）能大幅降低沟通成本，让团队成员快速上手。...规范的命名和详细的注释通常反映了开发者对代码结构的深思熟虑。例如，注释可以记录设计决策的背景，帮助后续开发者理解“为什么这样写”。这不仅提高了代码的可扩展性，也让重构或优化变得更加顺畅。...与其花时间为每个函数写详细注释，不如把精力放在实现更多功能或修复 bug 上。代码只要能跑，结果正确，是否“美观”并非首要考虑。 3. 复杂并非刻意为之在某些特定场景下，代码的复杂性是不可避免的。...职场老油条们那么写是“装菜”，可不是真的菜。对于这个问题，你怎么看？坚持编写规范代码，和在代码中“留一手”，哪种才更能构建个人的“技术护城河”？欢迎在评论区分享你的观点。感谢转发和点赞的各位~

1431 0

Pycharm写Python脚本 | Python新建文件自动注释

Pycharm写Python脚本 | Python新建文件自动注释效果如图所示： 1.打开Pycharm，点击File，选择Settings 2.点击Editor，选择里面的File and Code...Templates，找到并点击Python Script 3.在右侧空白处输入代码 #@Time: ${ DATE} ${ TIME} #@Author: SHAUN #@File...PRODUCT_NAME} 其中： {DATE}表示当前日期 {TIME}表示当前时间 {NAME}表示新建文件输入的文件名 {PRODUCT_NAME}表示使用的程序这样就完成了，以后每次新建python...文件，都会自动加上注释。

1.9K2 0

您找到你想要的搜索结果了吗？

是的

没有找到

转引的注释怎么写_java注释模板

如图三所示：图三类注释：图中的1号位置是注释快捷键，例如我配的是“cc”，打注释时就是用“/**cc -> Enter”，方法注释同理就是”/**mc -> Enter”。...* * @author *** * @createDate $date$ $time$ */ 类注释我写的比较简单，可以参考IDEA 创建类注释模板和方法注释模板 – 简书 date和time都是变量...方法注释和类注释的差别在于param字段是自己写的groovy脚本，如图所示，复制字符串到对应位置即可。...最近利用javadoc 工具生成注释，发现原来注解中的 “:” 不能有。 2. 原本方法注释中返回值为空也有return，根据javadoc，无返回值不应该写return。...其实我写这篇只是想把自己踩的坑说出来，希望和我一样的人能避免这个问题，主要还是要大家自己自己研究一下这个模板脚本的写法，然后写出适合自己的东西– 版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人

7.8K3 0

Python自学教程2-大牛们怎么写注释

在还没开始学代码前，就要先学会写注释。不会写注释的程序员会遭到鄙视和唾弃，甚至在工作中会被人穿小鞋。注释也不是随便写一下就行，用好注释还是有点讲究的。注释有什么用？...注释（Comments）主要是向阅读代码的人解释某些代码的作用和功能，它可以出现在代码中的任何位置。Python 在执行代码时会忽略注释，不做任何处理，就好像它不存在一样。...我们写完代码以后，可能会有代码审查，如果很难理解，公司可能会打回来，让你重新补齐注释。还有一种情况，当你半个月以后再来看之前写的代码，可能根本想不起来为什么这么写。...现在都还没说开始写代码呢就学大牛，好像有点早，但我以为好的注释习惯能快速提高写代码的速度。那么，一套好的注释习惯会包含哪些要素呢？...很多自学 Python 的人，看了很多教程，但最终还是不会用，不敢用，其中的原因就是没有根据实用性学习，总以为知识学得越多越好。

8571 0

需要 AI 写注释吗

但注释告诉我们：这个数字不是随便写的，不是魔法值，也不是可以由开发者单独决定的配置项，而是合规规则的一部分。这就是高质量注释的价值。...AI 时代，好注释应该写什么 AI 时代的好注释，不应该解释显而易见的代码行为，而应该解释无法从代码中稳定推导出来的信息。...写为什么，不写是什么低价值注释通常只是在复述动作： // 遍历订单 for (Order order : orders) { ... } 高价值注释则会解释约束： // 订单必须按创建时间顺序处理...结论：不是少写注释，而是写更有价值的注释 AI 时代，代码注释不会消失，但会分化。...真正成熟的工程实践，不是让代码库充满注释，也不是完全拒绝注释，而是让每一条注释都具备信息密度：少写这段代码做了什么，多写为什么必须这样做。

1590 0

Python 技巧篇-开头注释怎么写最好，开头注释需要包含什么，开头注释的重要性

开头注释除了必要的信息外，一些简单的介绍也是尤为重要呢，比如作者、创建日期、更新日期、里面代码大体是实现什么功能的简要介绍。这些介绍不但是规范，更是一种认真工作态度的体现。...下面给大家展示一下我的开头注释是怎么写的。 #!...windows 系统是根据扩展名 .py 来关联的，所以只要是 .py 结尾，直接就会用 python 来运行；以前还有这么写的，直接指明 python 的绝对位置：#!...user/bin/python 因为 python 有可能不在 bin 下面，env python 是直接找到 python 的安装位置，更实用。...一个好的程序员，当然要有一段好的开头注释，当然最好还要有自己的风格，让人一看就知道这是你写的，这就是你的门面，你的记号。

5.1K3 0

你写注释吗？写你就输了

因此，写注释不值得赞美，而是应该停下来问问自己，是否有更好的方式可以用代码来表达自己。 ? 带有少量注释的清晰而富于表现力的代码，要比带有大量注释的混乱而复杂的代码好得多。...如果你已经把代码弄得一团糟，不要花时间写注释来解释，而是要花时间梳理代码。如果每次写注释的时候，你都冥思苦想，觉得自己的表达能力不足，那么最终你就会写出简洁明了的代码，完全没有必要写注释。...如果你写注释是为了符合公司规定，或者你只是觉得有必要添加一些注释，那么你在注释时就不会进行适当的思考。...强制性注释这肯定会引起争议。如果规定每个函数都需要一个 Java 文档或 Python docstring，是不是有点傻？大多数时候，类或函数名已经告诉我们注释所描述的内容，它们是多余的。...*/ 小结我并不是提倡不写代码注释，只是建议不要过于依赖注释，这样可以使代码更干净、更有表现力，这也能提高开发人员的水平。

8212 0

【Python】Python 注释 ( 单行注释 | 多行注释 | 代码示例 )

文章目录一、Python 注释 1、单行注释 2、多行注释 3、代码示例单行注释 : # 单行注释多行注释 : """ 多行注释多行注释多行注释 """ 一、Python 注释 ---- Python...注释可以对代码进行解释说明 , 代码中的注释不会被执行 , 可以增加代码的可读性 ; 1、单行注释单行注释 : Python 中的单行注释以 # 开头 , # 右边是注释内容 ;...单行注释中 , # 与注释内容建议使用空格隔开 , 这是 Python 官方的建议 , 建议大家都遵守该规范 ; 单行注释可以独立占一行 , 也可以写在代码右侧 ; 在 C / C++ /...之间添加空格 , 警告信息消失 ; 代码示例 : 下面的代码中 , 第一行中的单行注释独占一行 , 第二行中的单行注释在代码的右侧 ; # 单行注释 print(123) #...单行注释 2、多行注释 Python 多行注释使用三个双引号引起来 ; 三个双引号即可以进行单行注释 , 又可以多行注释 , 代码如下 : """ 多行注释 """ """ 多行注释

8.4K4 0

来让人工智能帮你写注释吧，支持 Python

关于代码的注释，我自己也是很少写，但是时间一长，连自己都要看很久才知道啥意思，要让别人看明白，更是耗费时间了。为什么写代码不写注释，主要原因还是因为懒，懒得思考怎么写。...不过今天发现一个 VSCode 的插件，可以让 AI 帮你写注释了，写的清清楚楚明明白白。只要选中函数代码，然后按一个快捷键就会自动生成该方法的注释，可用来生成函数文档。...daily_avg(temps: List[float]) -> float: return sum(temperatures)/len(temperatures) 比如上面这样的函数，生成的注释效果如下...The average of the temperatures. """ return sum(temperatures)/len(temperatures) 看来 AI 完全知道你在写什么...其他它支持多种语言 JS、TS、Java、Python、PHP 等，有 VScode、IntelliJ 等插件版本，还可以在线试用[2]。

1.2K1 0

不写注释就是耍流氓？

不写注释就是耍流氓？关于写代码不写注释这么说 “我”不想写注释的原因如何才能写出漂亮的注释关于写代码不写注释这么说关于代码注释的争论一直存在，程序员社区中有不同的观点和实践。...写代码时是否应该写注释是一个有深度的话题，我认为需要综合考虑多个因素，而不是简单地将它们视为喜欢或讨厌的问题。首先，让我们讨论一下不写注释的情况。...但这并不意味着完全不写注释，因为某些情况下，注释是必要的，特别是当代码涉及复杂的算法、特殊的业务逻辑或不明显的细节时。...另一方面，有写注释的实践者认为注释可以提供重要的上下文信息和解释，帮助其他开发人员更快地理解代码的功能和意图。注释还可以在代码维护和团队协作方面发挥关键作用。...将注释视为代码质量和可维护性的工具，而不是一种令人烦恼的任务，将有助于更好地平衡这个问题。 “我”不想写注释的原因程序员不写注释的原因有多种，而且这种现象可以在编程社区中引起争议。

2870 0

Python 注释

Python中的注释有单行注释和多行注释。 Python 是使用 # 来进行注释的。这个等于是我们在 Java 中使用的 // 符号。...# Python 行内注释 # Python 单行注释 print("Hello, CWIKIUS!")...# Python 多行注释 - LINE 1 # Python 多行注释 - LINE 2 print("Hello, CWIKIUS!")...''' Python 多行注释块 - LINE 1 Python 多行注释块 - LINE 2 ''' print("Hello, CWIKIUS!")...""" Python 多行注释块 - LINE 1 Python 多行注释块 - LINE 2 """ print("Hello, CWIKIUS!")

2.8K4 0

写不好代码注释？这份注释指南一定要收好

这也是不少程序员一直头疼的问题，比如接手新代码时，没有注释，完全搞不清逻辑；自己写的注释，跟不上代码修改，成了误导；复杂逻辑不知道咋注释，别人也看不懂。...一、明确注释的目的目标设定理论提出：清晰、明确和可衡量的目标比模糊不清的目标更能提高工作效率。目的也同样。而我们写注释的主要目的是为了增强代码的可理解性。...下面列出了一些具体的注释目的，在写之前帮助我们理清思路，明确行动方向。（一）解释代码的功能和用途代码注释要让读者能够快速了解一段代码或一个函数的整体作用。...这包括注释的位置（行末、函数前等）、注释的符号（例如 Python 中常用的 # ）、以及注释的书写方式（是完整的句子还是短语等）。统一的风格可以使注释看起来更加整洁和专业。...例如，在一个 Python 项目中，规定函数注释采用如下格式：def some_function(arg1, arg2): """ 函数功能的简要描述参数: arg1 (数据类型

1.9K1 0

python注释

初学python 习得注释方法如下: #我是注释 print("hello") ''' 我是多行注释！...''' 其实就是#号和三个单引号（也可以双引号）啦看下面：这注释其实是表示py文件为utf-8编码，不然默认ASKII码保存文件 #coding=utf-8

1.8K10 0

给代码写注释时有哪些讲究？

注释虽然写起来很痛苦, 但对保证代码可读性至关重要，下面我们就以C/C++代码规范注释为例，将描述如何注释以及有哪些讲究。注释风格 1. 总述一般使用 // 或 /* */，只要统一就好。 2....说明 // 或 /* */ 都可以，但团队要在如何注释及注释风格上确保统一。文件注释 1. 总述在每一个文件开头加入版权、作者、时间等描述。...文件注释描述了该文件的内容，如果一个文件只声明，或实现，或测试了一个对象，并且这个对象已经在它的声明处进行了详细的注释，那么就没必要再加上文件注释，除此之外的其他文件都需要文件注释。 2....一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。不要在 .h 和 .cc 之间复制注释, 这样的注释偏离了注释的实际意义。...结语注释固然很重要, 但最好的代码应当本身就是文档，有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字。你写的注释是给代码阅读者看的, 也就是下一个需要理解你代码的人.

1.4K1 0

注释怎么写不容易挨揍？

注释虽然写起来很痛苦, 但对保证代码可读性至关重要，下面我们就以C/C++代码规范注释****为例，将描述如何注释以及有哪些讲究。 1、注释风格 1....说明 // 或 /* */ 都可以，但团队要在如何注释及注释风格上确保统一。 2、文件注释 1. 总述在每一个文件开头加入版权、作者、时间等描述。...文件注释描述了该文件的内容，如果一个文件只声明，或实现，或测试了一个对象，并且这个对象已经在它的声明处进行了详细的注释，那么就没必要再加上文件注释，除此之外的其他文件都需要文件注释。 2....一个一到两行的文件注释就足够了, 对于每个概念的详细文档应当放在各个概念中, 而不是文件注释中。不要在 .h 和 .cc 之间复制注释, 这样的注释偏离了注释的实际意义。...7、结语注释固然很重要, 但最好的代码应当本身就是文档，有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字。你写的注释是给代码阅读者看的, 也就是下一个需要理解你代码的人.

7042 0

【js】如何正确的写代码注释？

错误注释你的注释是不是这样的？ //时间戳日期格式化函数 function formTime(time,isyear){ } 亦或者是这样的？...、易维护、易理解，起到提示的作用的，上面的两个注释都是正确的，但是它起到的作用太低了，在正式工作中我们往往会协同开发，这种注释是万万不可的。...正确注释正确的注释就是文档注释，先来看看是什么样子。...，内容详细了很多，当然，不只是单单的内容多了，如果只是内容多了那么/* */段落注释同样也可以写，那么它还有什么优点呢？...优点方法提示 time是个字符串我们要截取字符串普通注释文档注释内容提示鼠标移动到函数以及参数上所给的提示。

2K2 0

讨厌别人不写注释，但自己也不爱写？那么试试这个IDEA的注释插件吧！

平时大家编程时，有没有养成良好的注释习惯呢？一个好的注释习惯对于代码的回溯、重构，或者对于他人解读，都有着莫大的帮助，但是大家编码的时候有没有觉得写注释会稍稍的让编码慢下来一点呢？...使用中，可以将光标移动到需要注释的类、方法或者属性上，然后通过快捷键ctrl \就可以进行自动注释。我们看下实际的使用效果：小伙伴会问了，那到底他是怎么自动注释的呢？...其实他就是后台自动通过翻译软件，将需要注释的类、方法或者属性进行翻译然后注释，所以说小伙伴只需要将方法的名字写的和实际效果一致，就能确保自动注释的效果。...、注释样式、返回值样式进行定制，总有一个能满足小伙伴们的使用习惯。...怎么样，是不是觉得整个小插件对编码注释有所帮助呢？赶紧来试试吧：点击下方卡片，关注公众号“TJ君” 回复“自动注释”，获取插件下载地址关注我，每天了解一个牛x、好用、有趣的东东

9421 0

写与不写：程序员对代码注释之争

写与不写：程序员对代码注释之争博主默语带您 Go to New World....⌨ 《写与不写：程序员对代码注释之争》摘要在程序员的世界里，注释常常成为了讨论的焦点。据说，程序员最烦的两件事是别人不写注释以及自己要写注释。为何写注释在开发过程中如此关键？...而且，我认为，写注释也是一种对自己和他人负责的态度。 2. 你认为程序员不写注释的原因是什么 2.1 追求编写的速度很多时候，程序员会因为项目的紧迫时间线而牺牲注释。...根据一个开发者调查，40%的程序员不写注释的原因是他们认为他们的代码是“自解释的”。...DB_CONNECTION_STRING = "your_secret_string" 3.7 利用工具生成文档注释有些编程语言提供了工具，例如Python的Docstring，可以帮助自动生成代码文档

4741 0

一个python写的去c语言注释的小脚本

/usr/bin/python import sys input = sys.argv[1] fp = open(input,"r") flag = 0 quote = 0

9141 0

python函数注释

函数注释是一个可选的功能，它允许在函数参数或者返回值中添加任意的元数据。无论是python本身还是标准库，都使用了函数注释。..., 'return': } 获取函数注释可以使用_annotations_方法。

1.4K4 0

点击加载更多

相关资讯

热门标签

活动推荐

运营活动

活动名称

广告关闭