A Comment on Comments

海康视觉平台VisionMaster实战入门:从通讯配置到工具应用 本文为海康VisionMaster视觉平台实战入门指南,详细介绍了从软件安装准备、与PLC等外部设备的通讯配置,到匹配定位、测量、畸变矫正等核心工具的应用方法。通过实战案例拆解,帮助工程师快速掌握如何搭建完整的机器视觉检测与引导定位系统,实现工业自动化项目落地。 阅读详情

In my first programming class in college, my teacher handed out two BASIC coding sheets. On the board, the assignment read "Write a program to input and average 10 bowling scores." Then the teacher left the room. How hard could this be? I don't remember my final solution but I'm sure it had a FOR/NEXT loop in it and couldn't have been more than 15 lines long in total. Coding sheets — for you kids reading this, yes, we used to write code out longhand before actually entering it into a computer — allowed for around 70 lines of code each. I was very confused as to why the teacher would have given us two sheets. Since my handwriting has always been atrocious, I used the second one to recopy my code very neatly, hoping to get a couple extra points for style.

Much to my surprise, when I received the assignment back at the start of the next class, I received a barely passing grade. (It was to be an omen to me for the rest of my time in college.) Scrawled across the top of my neatly copied code, "No comments?"

It was not enough that the teacher and I both knew what the program was supposed to do. Part of the point of the assignment was to teach me that my code should explain itself to the next programmer coming behind me. It's a lesson I've not forgotten.

Comments are not evil. They are as necessary to programming as basic branching or looping constructs. Most modern languages have a tool akin to javadoc that will parse properly formatted comments to automatically build an API document. This is a very good start, but not nearly enough. Inside your code should be explanations about what the code is supposed to be doing. Coding by the old adage, "If it was hard to write, it should be hard to read," does a disservice to your client, your employer, your colleagues, and your future self.

On the other hand, you can go too far in your commenting. Make sure that your comments clarify your code but do not obscure it. Sprinkle your code with relevant comments explaining what the code is supposed to accomplish. Your header comments should give any programmer enough information to use your code without having to read it, while your in-line comments should assist the next developer in fixing or extending it.

At one job, I disagreed with a design decision made by those above me. Feeling rather snarky, as young programmers often do, I pasted the text of the email instructing me to use their design into the header comment block of the file. It turns out that managers at this particular shop actually reviewed the code when it was committed. It was my first introduction to the term career-limiting move.

by Cal Evans

This work is licensed under a Creative Commons Attribution 3

010Editor实战:5分钟破解Zip伪加密文件(附BUUCTF真题解析) 本文详细介绍了如何使用010Editor快速破解Zip伪加密文件,包括BUUCTF真题的完整解析。通过修改关键字节,轻松解除伪加密状态,适用于CTF竞赛和实际工作场景,提升文件处理效率。 阅读详情

相关推荐

STM32 (基于HAL库) 硬件IIC任意地址读写任意字节----AT24CXX芯片

转了一圈,发现有关STM32的iic的硬件是使用比较少,基于HAL库的就更少,传统的,大家都是采用软件模拟的。有iic的协议相对复杂,同时灵活,尤其是不同的设备的I2C通信组合变化也不同,使用灵活的软件模拟也是可以理解的,在加上I2C的设备读写速度都比较低,硬件读写的优势就更无法体现,哪怕硬件I2C可以开启DMA,甚至在随机的读取少量字节的情况下。开启DMA反而效果更差。自然而然的硬件I2C就无人问津了。

qq_32273059的博客 1582

【VUE】组件递归的用法

comment.vue <template> <div> <div v-for="(item, index) in comment_list" :key="index"> <a-comment> <span slot="actions">{{ item.actions || "回复" }}</span> <a slot="author">{{ item.commen

厂长的博客 558

别再怕非观测区了!手把手教你用移相法搞定PMSM单电阻FOC的电流重构难题

本文详细解析了永磁同步电机(PMSM)单电阻FOC系统中非观测区的电流重构难题,重点介绍了移相法的工程实践。通过STM32平台的具体实现和调试指南,帮助工程师有效解决相电流检测中的采样窗口不足问题,提升系统稳定性和性能。

weixin_27252001的博客 436

python爬虫库四种类型-Python爬虫库BeautifulSoup获取对象(标签)名,属性,内容,注释

一、Tag(标签)对象1.Tag对象与XML或HTML原生文档中的tag相同。from bs4 import BeautifulSoupsoup = BeautifulSoup("Extremely bold","lxml")tag = soup.btype(tag)bs4.element.Tag2.Tag的Name属性每个tag都有自己的名字,通过.nam...

weixin_39805195的博客 1082

逆向实战:TikTok X-Gorgon算法解析与Unidg补环境技巧

本文详细解析了TikTok X-Gorgon算法的逆向工程全流程,包括参数定位、变种RC4算法还原及Unidbg补环境技巧。通过动态调试与静态分析相结合,揭示了X-Gorgon的生成逻辑和加密细节,为移动安全研究提供了实用指南。

weixin_28568819的博客 698

AI编程工具选哪个更高效?开发者深度评测

无论是代码生成、错误修复,还是架构设计,AI都能提供强大的辅助能力。然而,市面上AI编程工具众多,如何选择最适合自己的?本文将从代码质量、响应速度、多语言支持、集成能力等多个维度,为你解析2025年最主流的几款AI编程工具,帮助你做出更高效的选择。根据2025年最新调研数据,全球超过85%的开发者正在使用AI编程工具辅助开发,相比2023年增长了近40%。合理利用AI,能让你的开发效率提升数倍,但真正的核心竞争力,仍然在于你的编程思维和解决问题的能力。:技术较强的开发者、重视数据隐私的企业。

1858

匹配html中a标签的内容

利用正则表达式来匹配html中a标签中的内容:      获取html内容:      $contents = file_get_contents('a.html');     利用正则匹配:      preg_match_all('/(.*)/',$contents,$matches);      输出:      print_r($matches[1]);

我本善良的博客 2560

UOS忘记密码别慌!用LiveCD工具5分钟搞定,附命令行救援模式详细步骤

本文详细介绍了UOS系统密码遗忘时的两种解决方案:图形化LiveCD工具和命令行救援模式。针对普通用户,LiveCD工具提供5分钟快速重置密码的便捷操作;而技术人员可通过命令行深度解析系统分区挂载与密码修改流程。文章还包含安全加固建议,帮助用户预防类似问题发生。

weixin_27032989的博客 593

A benchmark for toxic comment classification on Civil Comments dataset——基于Civil Comments数据集的毒性评论分类基准

A benchmark for toxic comment classification on Civil Comments dataset——基于Civil Comments数据集的毒性评论分类基准

Together_CZ的博客 1529

用友U8库龄分析避坑指南:物料出入库日期计算的5个常见错误

本文深入剖析了在用友U8系统中进行库龄分析时,物料出入库日期计算的五个常见陷阱。从数据源选择、业务类型过滤、计价方式逻辑、期初数据处理到查询性能优化,逐一解析错误根源并提供避坑指南,帮助企业获得准确的库龄数据,有效管理库存与资金风险。

weixin_29209801的博客 457

自己的搭建的slam机器人建图导航测试

1、前言 这里是对自己搭建的slam机器人建图导航的功能测试,原本并不想写这一篇的,因为每个小伙伴的需求都不一样,但是发现还是有同学有需求,于是就有了这一篇。本篇属于说明分享类文章,不涉及细节解释。按照步骤操作即可。 本次测试需要建图算法my_slam_gmapping、导航框架navigation、以及explore_lite功能包、mbot_teleop键盘控制功能包等。 环境:ubuntu mate 16.04 + ROS Kinetic 功能包下载:在公众号:小白学移动机器人,发送:建图导航测试,即

「小白学移动机器人」一个专注分享移动机器人相关知识的公众号! 8712

117 Posted by seenagape on June 23, 2012 Leave a comment (0) Go to comments The BACKUP_TAPE_IO_SLAVE

117 Posted by seenagape on June 23, 2012 Leave a comment (0) Go to comments The BACKUP_TAPE_IO_SLAVES parameter is set to FALSE for the database instance. Which statement is true while performing a

EVISWANG的博客 2812

解锁RK1126与SC132GS摄像头适配密码:技术与代码全解析

本文详细介绍了瑞芯微RK1126芯片与SC132GS摄像头的适配方法。首先分析了RK1126的四核Cortex-A7处理器、Mali-T860 GPU等硬件特性,以及SC132GS的130万像素、全局快门等技术参数。重点阐述了基于MIPI CSI接口的硬件连接原理和基于V4L2框架的软件驱动设计,并提供了完整的初始化、数据采集和图像处理代码实现。针对常见连接和图像质量问题给出了解决方案,展现了该组合在智能安防、工业检测等领域的应用潜力,为开发者提供了实用的技术参考。

远程部署调试 运行安装 项目调试 二次开发 项目技术新 持续迭代 部分源码免费分享 1507

GBase8a数据库中表的comment信息

1.通过showcreatetable方式获取表的创建语句,查找comment信息; 2.查询information_schema.columns、information_schema.tables系统表,获取comment信息;

lbfk的专栏 445

廖雪峰Python教程[完整版]

廖雪峰的python教程整理的,已经排好版了,而且还是完整的,适合小白

win10 跳过U8环境检测的IE WebControls.rar

win10 安装u8的时候 提示IE WebControls 不通过,这个工具可以欺骗u8的检查。 跳过U8环境检测的IE WebControls。提示导入失败后,重新检测通过。

Oracle数据库中 COMMENT ON 语句

Oracle Comment On Table才是给视图添加注释而不是Comment On View

zxrhhm的博客 2822

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

oracle comment on的用法

oracle中用comment on命令给表或字段加以说明,语法如下: COMMENT ON   { TABLE [ schema. ]     { table | view }   | COLUMN [ schema. ]     { table. | view. | materialized_view. } column   | OPERATOR [ schema. ] opera

产品经理,程序人生 1万+

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

comment on 视图_oracle 使用comment语句添加表注释

使用oracle comment语句可以给表、字段、视图等对象添加备注信息。大致语法为:comment on TABLE table_name IS ‘备注内容‘;权限要求:默认情况下用户只能给属于自己的对象添加注释。如果要想给其他用户对象添加注释需要拥有权限:COMMENT ANY TABLE相关数据字段视图:USER_TAB_COMMENTSDBA_TAB_COMMENTSALL_TAB_CO...

weixin_33028765的博客 858

oracle使用comments建表,Oracle 使用comment语句添加表注释

使用Oracle comment语句可以给表、字段、视图等对象添加备注信息。大致语法为:comment on TABLE table_name IS '备注内容';权限要求:默认情况下用户只能给属于自己的对象添加注释。如果要想给其他用户对象添加注释需要拥有权限:COMMENT ANY TABLE相关数据字段视图:USER_TAB_COMMENTSDBA_TAB_COMMENTSALL_TAB_CO...

weixin_39638464的博客 1758

Oracle comment添加注释

Oracle comment添加注释 Oracle 的 COMMENT 语句可以给一个列、表、视图或快照添加一个最多 2K 字节的注释。注释被存储...

coco3600的博客 2872

Oracle Comment添加表备注和列备注添加和查询comment on table or culumn

        oracle开发过程中,经常会用到comment on table is 和comment on column is来添加备注,以便与查看表和列的作用。         添加标注备注的方法如下     --添加表备注        COMMENT ON TABLE b_so IS '发货订单'; 复制代码       添加列备注     -...

雨后的空气 1万+

oracle 中comment on,oracle中用comment on命令给表或字段加以说明

oracle中用comment on命令给表或字段加以说明,语法如下:COMMENT ON{ TABLE [ schema. ]{ table | view }| COLUMN [ schema. ]{ table. | view. | materialized_view. } column| OPERATOR [ schema. ] operator| INDEXTYPE [ schema. ]...

weixin_29374181的博客 768

oracle Comment添加表备注和列备注

在开发过程中,处理有集中式的表和列管理以外,经常

IT开发专栏 7380

comment on 视图_oracle comment命令用法示例分享

oracle中用comment on命令给表或字段加以说明,语法如下:COMMENT ON{ TABLE [ schema. ]{ table | view }| COLUMN [ schema. ]{ table. | view. | materialized_view. } column| OPERATOR [ schema. ] operator| INDEXTYPE [ schema. ]...

weixin_42327688的博客 979

comment on 视图_华为GaussDB T 使用COMMENT为对象添加注释

COMMENT ON功能描述使用comment语句在字典中增加一个关于表、视图或列的注释信息。通过USER_TAB_COMMENTS、DBA_TAB_COMMENTS或USER_COL_COMMENTS、DBA_COL_COMMENTS系统视图可以查看注释信息。注意事项为自己的表增加注释时,不需要权限;为任意用户的表增加注释时,需要执行语句的用户拥有COMMENT ANY TABLE权限。支持...

weixin_29159127的博客 1582

comment on 视图_oracle comment on的用法 | 学步园

oracle中用comment on命令给表或字段加以说明,语法如下:COMMENT ON{ TABLE [ schema. ]{ table | view }| COLUMN [ schema. ]{ table. | view. | materialized_view. } column| OPERATOR [ schema. ] operator| INDEXTYPE [ schema. ]...

weixin_39609622的博客 200

oracle-comment on的用法

转载:https://blog.youkuaiyun.com/wangmuming/article/details/28878461 oracle中用comment on命令给表或字段加以说明,语法如下: COMMENT ON { TABLE [ schema. ] { table | view } | COLUMN [ schema. ] { table. | view....

lightningmn的博客 2万+
上一篇: Coding with Reason
下一篇: Comment Only What the Code Cannot Say
hellominix
博客等级 码龄14年 0粉丝 4原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值