- 综合排序
- 最热优先
- 最新优先
- 来自专栏CSDNToQQCode
Python与人工智能——9、Python的代码注释与域注释
正文 开发工具：Pythony与人工智能——3、Python开发IDE工具VSCode-CSDN博客 Python的代码注释 单行与多行注释 代码注释分为单行注释与多行注释。 单行注释：#。 # 这是一个多行注释 # 用于解释一段复杂的代码逻辑 # 或者提供一些额外的信息 文档字符串（域注释） 文档字符串是用三引号（"""或'''）括起来的字符串，通常放在模块、类、函数的开头。 总结 Python 代码注释用 "#" 开头，可用于单行或多行。 域注释即文档字符串，用三引号括起放在模块、类、函数开头，提供详细说明，可通过help()查看，有助于提高代码可读性和可维护性，方便他人理解和工具生成文档。 这里给个基本类注释声明： """ 文件名：[你的文件名].py 描述：[对这个文件的简要描述] 编写日期：[具体日期] 作者：[你的名字] 注意：本代码经过精心编写和测试，但不能保证完全无
42510编辑于 2024-09-23 - 来自专栏韩曙亮的移动开发专栏
【Python】Python 注释 ( 单行注释 | 多行注释 | 代码示例 )
文章目录 一、Python 注释 1、单行注释 2、多行注释 3、代码示例 单行注释 : # 单行注释 多行注释 : """ 多行注释 多行注释 多行注释 """ 一、Python 注释 ---- Python 注释 可以 对 代码 进行解释说明 , 代码中的 注释 不会被执行 , 可以 增加代码的可读性 ; 1、单行注释 单行注释 : Python 中的 单行注释 以 # 开头 , # 右边是注释内容 ; 之间添加空格 , 警告信息消失 ; 代码示例 : 下面的代码中 , 第一行中的 单行注释 独占一行 , 第二行中的 单行注释 在代码的右侧 ; # 单行注释 print(123) # 单行注释 2、多行注释 Python 多行注释 使用三个双引号 引起来 ; 三个双引号 即可以进行单行注释 , 又可以多行注释 , 代码如下 : """ 多行注释 """ """ 多行注释 多行注释 多行注释 """ print(12.13) 3、代码示例 代码注释示例 : """ 在本代码中展示字面量 - 字面量写法 - 打印字面量 """ # 整型字面量 123 # 浮点型字面量
7.6K40编辑于 2023-04-04 - 来自专栏四楼没电梯
代码注释对齐
图1 图2 感觉上我们认为图2是我们想要的注释对齐的效果。但感觉是不能拿来代码实现的。 所以我们需要定义什么叫注释对齐。如下图 假设代码部分的长度为CL,代码到//之间的长度为Width。 代码先上电梯，电梯容量为fact，等代码快上完，注释再上。代码上的时候发现没上满，就拿空格占位，空着也不让注释上。 2.指定Width(程序中的min)方式 相当于限额。 代码要先占前W个位置，人不够用空格占，都占完了，注释才能上来。 这样就会有个问题，代码如果超过W，位置不够用了怎么处理。 处理方式有， 2.1代码和注释都将就，都满了，就顺序上了。 特别的，如果fact=1，min=1，则可以实现注释不对齐，即图2向图1的转换。 建议fact和min都取4的整数倍，这样缩进之间的注释也比较有层次。 因为js不熟，所以代码基本是类C的风格，不太简洁。
56510编辑于 2024-10-12 - 来自专栏方亮
谈代码注释
只要写代码，就会遇到代码注释的问题。在不同的公司，不同的项目组，不同的项目中，可能会有不同的注释标准。有些标准让我们感觉很受益，有些则让我们感觉很反感。 当时我们讨论代码注释该怎么写的问题，最终同事抛出这么一个观点：“我之前在X为干过，那儿就需要每行代码都写注释，所以我们应该执行这样的标准”。 也许X为的确有严格的代码注释量要求（也许“注释行数”/“代码行数”>0.5），于是这家外包公司就做了一个“任何一行代码都要写注释”的要求。 在讨论这个话题之前，我先说下我对代码和注释的认识。 首先我认为代码要写的和注释一样表意。 往往一份文件包含代码和注释两部分，而阅读这份文件也有两个主体——编译器和人。编译器只是通过代码来获得逻辑信息，而人的要通过代码和注释一起理解逻辑和业务。
1.2K30发布于 2019-01-16 - 来自专栏hui
Python 代码注释
注释的作用 用自己熟悉的语言，在程序中对某些代码进行标注说明，增强程序的可读性。 ，然后再编写相应的说明文字 在代码后面增加单行注释 在程序开发时，同样可以使用 # 在代码的后面（旁边）增加说明性的文字 但是，需要注意的是，为了保证代码的可读性，注释和代码之间 至少要有 两个空格 示例代码如下 ，一行无法显示，就可以使用多行注释 要在 Python 程序中使用多行注释，可以用 一对 连续的 三个 引号(单引号和双引号都可以) 示例代码如下： #! 注释不是越多越好，对于一目了然的代码，不需要添加注释 对于 复杂的操作，应该在操作开始前写上若干行注释 对于 不是一目了然的代码，应在其行尾添加注释（为了提高可读性，注释应该至少离开代码 2 个空格） 绝不要描述代码，假设阅读代码的人比你更懂 Python，他只是不知道你的代码要做什么 养成写注释的习惯，让自己、让同事、让借鉴者有着更好的代码阅读体验。
1.6K20编辑于 2021-12-06 - 来自专栏跟着小郑学JAVA
【JavaSE专栏9】Java 注释知多少
文档注释是 Java 特有的，文档注释可通过 JavaDoc 工具转换为 HTML 文件。 一般注释用于注释代码或者实现细节。 文档注释从实现自由的角度描述代码的规范，手上没有源码的开发者也应可以读懂文档注释。 注释应该仅包含与阅读和理解程序有关的信息。 在实战开发中，对设计决策中重要的，或者不是显而易见的地方进行说明是可以的，但应避免提供代码中已经明确表达出来的重复信息，多余的注释很容易过时。 提示：频繁的注释是质量较低的代码之一。 尾端注释用于极短的注释需求，尾端注释和所要描述的代码块在同一行，但其中要有足够的空格来分开，另外也要注意缩进问题。 注释要当简单明了，能用一句话就不用两句。如果注释太复杂，请检查代码逻辑是否有问题。 注释既要阐述相应代码能做什么，还要解释为什么要这么做和开发约束。
32720编辑于 2023-08-01 - 来自专栏CreateAMind
planet 代码注释解读
https://github.com/JingbinLiu/planet_A/commits/master
1.1K20发布于 2019-04-28 - 来自专栏我和未来有约会
核心代码（未注释）
//---------------------------------------------------Over var Over = new Object(); Over.Init = function(e) { Over.ent(e); }; Over.ent = function(e) { e.onEnterFrame = function() { if (e.enabled) { if (e.hitTest(ship_mc.hit02_mc)
1.8K50发布于 2018-01-16 - 来自专栏大数据-BigData
代码注释的艺术，优秀代码真的不需要注释吗？
注释会随着源代码，在进入预处理器或编译器处理后会被移除。这是雷布斯 1994 年写的一段 MASM 汇编代码，注释与代码整体结构都非常清晰。 有注释的代码都存在着一些瑕疵，认为足够完美的代码是不需要注释的。 ，读代码时代码本身就能很好的表达具体的含义，我们完全不需要看注释，并且注释也不会给我们提供更多有效的信息。 当需要为一段代码加上注释时，说明代码已经不能很好的表达意图，于是大家开始为这段代码添加注释。 这里有非常多的空间是代码很难阐述或无法阐述的，配上注释的代码并非就是糟糕的代码，相反有些时候，注释还是好代码最棒的僚机。
83620编辑于 2022-09-08 - 来自专栏算法微时光
注释代码使用模板
c/c++模板 /** * \brief Loads an item by name from this linker. * * \param linker the linker to load from * \param module the name of the module to get * \param name the name of the field to get * \param item where to store the extracted item * * \re
1.2K10发布于 2020-10-29 - 来自专栏全栈程序员必看
pycharm多行代码同时注释、去除注释_vs如何统计代码行数
使用pycharm编写Python脚本的时候，先选中需要注释的行，然后同时按键盘右下角的—-Ctrl和Ctrl键正上方的‘/’键—可以实现多行注释 注意： 1、只有在pycharm中编写Python代码 （以.py结尾的文件）才能用此方法去多行注释 2、在选中行的时候不管是全部选中，还是只选中了该行中的的部分代码，都能实现多行注释，如下图： 注释前： 注释后： 发布者：全栈程序员栈长，转载请注明出处
2.6K30编辑于 2022-09-27 - 来自专栏落叶飞翔的蜗牛
IDEA自动生成代码注释
注释就是对代码的解释和说明。目的是为了让别人和自己很容易看懂，一看就知道这段代码是做什么用的。正确的程序注释一般包括序言性注释和功能性注释。序言性注释的主要内容包括模块的接口、数据的描述和模块的功能。 IDEA自动生成类注释 1.打开idea-->选择File-->选择settings 2.设置类注释 3.新建测试类，模拟注释自动生成 IDEA自动生成方法注释 1.打开idea-->选择File */ 5.勾选所有代码适用选项 6.点击EDIT VARIABLES并编辑，其中VAR1输入以下groovy脚本，并保存。 ，二是自己写注释。 关于写注释，一直有人争论不休，有的人认为写代码必须要写注释，而又的人认为代码就是注释，何必再写一遍？希望本文可以对你有所帮助。
7.7K20发布于 2021-09-28 - 来自专栏JNing的专栏
个性代码注释 大合集
┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┐ │Esc│ │ F1│ F2│ F3│ F4│ │ F5│ F6│ F7│ F8│ │ F9│ 1│@ 2│# 3│$ 4│% 5│^ 6│& 7│* 8│( 9│) 0│_ -│+ =│ BacSp │ │Ins│Hom│PUp│ │N L│ / │ * │ - │ ├───┴─┬─┴─┬─ ──┼───┼───┤ │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │{ [│} ]│ | \ │ │Del│End│PDn│ │ 7 │ 8 │ 9 $$d$$F // $$" ""^"$$$P"$P9$ // JP .o$$$$u:$P $$ // | | ) __\ | | | | /__ (vvv(VVV)(VVV)vvv) */ Ref： 超有意思的程序代码注释
2.2K20发布于 2018-09-27 - 来自专栏猿说编程
4.python代码注释
一.什么是代码注释 代码注释就是给一段代码加上说明，表明这段代码的作用或者实现的功能，方便别人阅读代码。打个形象的比喻： ? 问题来了，那个女孩是谁？张三？李四？王五？ 加上注释再来一遍：放开小红。 三.python代码注释的几种方式 1.单行注释，使用英文符号 # # python注释代码 1 # python注释代码 2 # python注释代码 3 # python注释代码 4 2. 多行注释 方法一：英文状态下使用单引号 ''' python注释代码 1 python注释代码 2 python注释代码 3 python注释代码 4 ''' 方法二：英文状态下使用双引号(和方法一有点类似 注释代码 1 # python注释代码 2 # python注释代码 3 # python注释代码 4 四.回到第一个python项目-helloworld # ! utf-8 _*- """ @Author:何以解忧 @Blog(个人博客地址): https://www.codersrc.com/ @File:helloworld.py @Time:2019/9/
1.3K20发布于 2020-03-12 - 来自专栏猿说编程
4.python代码注释
一.什么是代码注释 代码注释就是给一段代码加上说明，表明这段代码的作用或者实现的功能，方便别人阅读代码。打个形象的比喻： ? 问题来了，那个女孩是谁？张三？李四？王五？ 加上注释再来一遍：放开小红。 三.python代码注释的几种方式 1.单行注释，使用英文符号 # # python注释代码 1 # python注释代码 2 # python注释代码 3 # python注释代码 4 2.多行注释 方法一：英文状态下使用单引号 ''' python注释代码 1 python注释代码 2 python注释代码 3 python注释代码 4 ''' 方法二：英文状态下使用双引号(和方法一有点类似 注释代码 1 # python注释代码 2 # python注释代码 3 # python注释代码 4 四.回到第一个python项目-helloworld # ! 何以解忧 @Blog(个人博客地址): https://www.codersrc.com @Github:www.github.com @File:helloworld.py @Time:2019/9/
78710发布于 2020-01-11 - 来自专栏狗哥的 Java 世界
你会写代码注释吗？
题 图：pexels 来 源：网络 预 计 阅 读 时 间：5.2分钟 1、这是一个被代码耽误的诗人 2、来一份1987年的代码看看 3、产品经理要对此负责 4、不敢看，也不敢问 5、Nike robots.txt 上的注释 查看地址：https://www.nike.com/robots.txt 6、程序员正确发牢骚的地方 7、阅读源码的人，心里一定的崩溃的 8、第一天上班看到这段注释就想辞职 9、我能说什么 10、这个功能可以收客户多少钱？ 全文完
69340发布于 2019-11-06 - 来自专栏python学习教程
Python代码规范之注释
1、注释 1.1、块注释 “#”号后空一格，段落件用空行分开（同样需要“#”号） # 块注释 # 块注释 # # 块注释 # 块注释 1.2、行注释 至少使用两个空格和语句分开，注意不要使用无意义的注释 # 正确的写法 x = x + 1 # 边框加粗一个像素 # 不推荐的写法(无意义的注释) x = x + 1 # x加1 1.3、建议 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释 示例 -------- 示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行 >>> a=[1,2,3] >>> print [x + 3 for x in a] [4, 5, 6] """ 文档注释不限于中英文, 但不要中英文混用 文档注释不是越长越好, 通常一两句话能把情况说清楚即可 模块、公有类、公有方法, 能写文档注释的 , 应该尽量写文档注释
5.5K20发布于 2019-08-26 - 来自专栏全栈程序员必看
pycharm 多行注释_注释代码快捷键是什么
大家好，又见面了，我是你们的朋友全栈君 多行注释 选中代码后 快捷键 Ctrl + / 单行注释 选中代码或者光标停留在该行，然后使用快捷键 Ctrl + / 多行代码缩进 选中代码后，快捷键Tab 多行代码取消缩进 选中代码后，快捷键shift + Tab 发布者：全栈程序员栈长，转载请注明出处：https://javaforall.cn/174339.html原文链接：https://javaforall.cn
4.2K30编辑于 2022-09-27 - 来自专栏python3
Python实现代码统计(代码+注释+空
coding: utf-8 -*- """ Created on Thu Apr 17 17:15:40 2014 @author: author """ import os; path_head = '代码路径头部 ' path_list = '代码绝对路径' fileClasses = ['java'] #需要统计的文件类型 totalLines = 0 commentAll = 0 normalAll = '/*') and True==i.endswith('*/')): commentLines=commentLines+1 #注释 : commentLines=commentLines+1 comment=True #注释 :%d' %(normalAll)) print ('总注释行数:%d' %(commentAll)) print ('总空行数:%d' %(whiteAll)) 参考网上的代码修改而成，没有什么技术含量
93910发布于 2020-01-08 - 来自专栏友人a的笔记丶
如何批量去除代码内的所有注释？Remove.exe批量去除代码注释
写注释是一个非常好的习惯，但是某些情况下，我们又不想保留代码里的注释，于是就有了下面这个小软件（大小仅1.6m）。 点击此处下载：https://nicen.cn/collect/remove.exe Remove.exe 一个批量去除代码内所有注释的小工具，支持去除C家族系列的单行和多行注释，比如下面这种： /* 多行注释 */ // 单行注释 1.使用说明 双击运行exe文件，将会弹出如下的窗口界面： 启动 点击选择代码目录，选择需要去除注释的项目目录，之后会弹出第二个窗口，如下： 参数 选择需要排除的文件或目录 ，然后输入需要移除注释的文件的格式类型，点击运行： 移除注释 耐心等待处理结束。 提醒 移除注释之前，记得备份一份带注释的源文件，代码无价，慎重操作
1.7K20编辑于 2023-10-18
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号