建议152：最少，甚至是不要注释

最新推荐文章于 2023-12-17 14:42:09 发布
转载 最新推荐文章于 2023-12-17 14:42:09 发布 · 400 阅读 · 0

本文探讨了现代软件开发中减少代码注释的理念，提倡通过使用有意义的命名来替代注释，以此提高代码的可读性和维护性。文章指出，过度依赖注释可能导致代码质量下降，并提出了一些关于何时应该添加注释的指导原则。

建议152：最少，甚至是不要注释

以往，我们在代码中不写上几行注释，就会被认为是钟不负责任的态度。现在，这种观点正在改变。试想，如果我们所有的命名全部采用有意义的单词或词组，注释还有多少存在的价值。

即便再详细的注释也不能优化糟糕的代码。并且注释往往不会随着代码的重构自动更新，有时候我们可能会在修改代码后忘记更新那段用来表达最初意图的文字了。所以，尽量抛弃注释吧，除非我们觉得只有良好的代码逻辑和命名仍旧不足以表达意图。

当然，有些注释可能不得不加，如一些版权信息。另外，如果我们正在开发公共API，保持一份良好的严格按照格式要求所写的注释有利于生成API参考手册。

当前有一种主张：不要写注释，或者尽量保持最少注释。

但前提是所有的命名全部采用有意义的单词或词组。

 

 

转自：《编写高质量代码改善C#程序的157个建议》陆敏技

47、地图开发中的坐标、注释与覆盖层应用
o1p2q3r的博客
11-06 7
本文深入探讨了地图开发中的核心概念与技术应用，涵盖Map Kit的三种坐标系统（经纬度、墨卡托、图形坐标）及其转换原理；详细讲解了注释与注释视图的自定义实现，以及使用MKPolyline绘制回家路线的覆盖层技术；并介绍了多种位置监控策略，包括近似位置监控、区域监控和减少位置更新频率等，以平衡精度与能耗。文章还展望了地图开发在AR融合、高精度地图和人工智能方向的发展趋势，并提供了实践建议与学习路径，适合iOS地图开发者参考与进阶。
ABAP CDS DEFINE VIEW 完整实践指南：从命名到授权、从老式 DDIC 视图到可运行示例
最新发布
2007 年 ~ 2025 年，深耕 SAP 技术 18 年
10-18 50
摘要： 本文系统介绍了ABAP CDS视图中DEFINE VIEW的定义与使用。首先解释其"一个定义，两个名字"的特点：CDS实体名用于开发消费，DDIC SQL视图名用于数据库落地。接着分解标准语法结构，强调推荐使用CDS实体名访问以获取完整语义安全控制。文章还阐述了访问控制注解和参数化视图的编写方法，并通过航空公司航班数据的完整示例，展示从视图定义到ABAP程序调用的全流程。最后通过建筑蓝图的类比，说明CDS视图分层设计的工程价值。
编写高质量代码改善C#程序的157个建议——建议152：最少，甚至是不要注释
weixin_30782293的博客
08-24 96
建议152：最少，甚至是不要注释 以往，我们在代码中不写上几行注释，就会被认为是钟不负责任的态度。现在，这种观点正在改变。试想，如果我们所有的命名全部采用有意义的单词或词组，注释还有多少存在的价值。 即便再详细的注释也不能优化糟糕的代码。并且注释往往不会随着代码的重构自动更新，有时候我们可能会在修改代码后忘记更新那段用来表达最初意图的文字了。所以，尽量抛弃注释吧，除非我们觉得只有良好的代码逻辑...
本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。
热门推荐
qq_48440248的博客
12-17 2万+
输入格式： 本题无输入。 输出格式： 按照以下格式输出： 152 = 个位数字 + 十位数字10 + 百位数字100 #include <stdio.h> int main() { int a,b,c; a = 152%10; b = 152/10%10; c = 152/100; printf("152 = %d + %d*10 + %d*100",a,b,c); } ...
PTA—C语言练习题
lcyiloveyou的博客
03-23 8451
复习C练习题 1-1:Hello World! 要求：编写程序，输出一个短句“Hello World"。 #include<stdio.h> int main(void){ printf("Hello World!"); return 0; } 1-2:温度转换 要求：本题要求编写程序，计算华氏温度150°F对应的摄氏温度。计算公式：C=5×(F−32)/9，式中：C表示摄氏温度，F表示华氏温度，输出数据要求为整型。 输出格式：fahr = 150, celsius = 计算所
整数152的各位数字
majiamin123的博客
03-07 6676
本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。 输入格式： 本题无输入。 输出格式： 按照以下格式输出： 152 = 个位数字 + 十位数字10 + 百位数字100 #include <stdio.h> #include <stdlib.h> /* run this program using the console pauser or add yo...
7-7 整数152的各位数字
tang7mj的博客
08-14 1389
本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。
【VSCode注释：从理论到实践】理解背后的原理，注释不仅仅是注释
# 1. 注释在软件开发中的重要性 ## 1.1 软件开发中的沟通桥梁 ...注释可以弥补代码表达上的不足，尤其是在处理复杂的算法或逻辑时，一个恰到好处的注释，可以让你免于编写冗长且难以理解的代码片段，使代码结构
改善C#程序的157个建议
qq_30725967的博客
12-27 631
《编写高质量代码：改善C#程序的157个建议》 1：使用Framework4.0； 2：使用Release模式； 3：部分TIP由于简单未给出源码； 目录 前　言 第一部分　语言篇 第1章　基本语言要素 / 2 建议1：正确操作字符串 / 2 建议2：使用默认转型方法 / 6 建议3：区别对待强制转型与as和is / 9 建议4：TryParse比Parse好 / 12 建议5：使用int?来确保...
函数与注释：编程中的关键要素
### 代码格式化的艺术：提升代码可读性与可维护性 #### 1. 代码格式化的重要性 代码格式化至关重要，它是专业开发者进行有效沟通的关键。良好的代码格式能给人留下整洁、一致且注重细节的印象，让人觉得这是专业...
实验1 数据类型与运算 7-2 整数152的各位数字
2301_80335799的博客
12-17 314
本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。
PTA 算法设计与分析-实验1 （第一章）
qq_65440203的博客
10-22 970
本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。
浙大版《C语言程序设计实验与习题指导（第4版）》题目集 实验2-2-7 整数152的各位数字
二三hhh的博客
06-09 815
题目要求： 本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。 输入格式: 无 输出格式: 按照以下格式输出： 152 = 个位数字 + 十位数字10 + 百位数字100 代码： #include <stdio.h> int main() { int a, b, c; //a为个位数字，b为十位数字，c为百位数字 a = 152 % 10; b = 152 / 10 % 10; c = 152 / 100; printf("152 = %d + %d*10 +
7-1 整数152的各位数字
weixin_57480178的博客
10-19 1007
输出整数152的个位数字、十位数字和百位数字的值
PTA:实验2-2-7 整数152的各位数字
m0_73422835的博客
01-03 2156
浙大版《C语言程序设计实验与习题指导（第4版）》PTA题目集
5-18 整数152的各位数字 (10分)
愿欲一听其说
03-01 1万+
本题要求编写程序，输出整数152的个位数字、十位数字和百位数字的值。 输入格式： 本题无输入。 输出格式： 按照以下格式输出： 152 = 个位数字 + 十位数字*10 + 百位数字*100 #include int main(void) { int a,b,c,z; z = 152; a = z / 100; b = z / 10 % 10
掌握敏捷开发核心技巧：提升项目效率
使用函数、方法、类、甚至重构现有代码库来避免这种重复是保持代码库健康的关键。 第2章 将注释转换为代码 注释并不是代码的一部分，它们不会被执行，且随着时间推移可能会过时。敏捷开发鼓励将注释的内容融入到...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值