惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Microsoft Azure Blog
Microsoft Azure Blog
GbyAI
GbyAI
P
Proofpoint News Feed
Engineering at Meta
Engineering at Meta
Recent Announcements
Recent Announcements
L
LangChain Blog
B
Blog
阮一峰的网络日志
阮一峰的网络日志
Microsoft Security Blog
Microsoft Security Blog
博客园 - 【当耐特】
M
MIT News - Artificial intelligence
D
Docker
WordPress大学
WordPress大学
J
Java Code Geeks
奇客Solidot–传递最新科技情报
奇客Solidot–传递最新科技情报
The GitHub Blog
The GitHub Blog
博客园 - 叶小钗
Last Week in AI
Last Week in AI
Stack Overflow Blog
Stack Overflow Blog
有赞技术团队
有赞技术团队
MyScale Blog
MyScale Blog
H
Hackread – Cybersecurity News, Data Breaches, AI and More
MongoDB | Blog
MongoDB | Blog
博客园 - Franky

博客园 - xiaosonl

学习手札#3 NHibernate缓存 产品的简单性 关于过度设计的思考(上) 让ASP.NET MVC的Controller输出不同类型数据 学习手札#2 故事点和小时数的思考 学习笔记#1 键值对数据库 SQLite数据迁移 探讨一种在Silverlight不普及情况下的部署策略 有用的文档 Silverlight产品布署策略 探讨一种Silverlight的异步编程模式 下半年要看完消化的技术类书籍 中小型企业的人员流失 谈谈Ruby On Rails和ASP.NET 工作中的系统学习 Uml中的关联与依赖关系 TDD与重构设计 C#中使用位运算来实现权限管理 Silverlight中JavaSciprt无法访问托管类抽象成员的解决方法
代码的注释
xiaosonl · 2010-03-27 · via 博客园 - xiaosonl

代码的注释

2010-03-27 14:14  xiaosonl  阅读(862)  评论(2)    收藏  举报

这几年来看过一些有关编码实践的书和文章,发现一个规律:

国人的建议大多要求注释详尽,让代码更易读易懂;而老外的建议几乎是尽可能的少,比如只写一些作者意图类的,或代码本身无法直接表达的意思。

这种区别,一方面是大概是国人编码水平不如老外,需要注释来弥补可读性;另一方面,就是代码是用英语来写的,这个是很重要的。虽说代码写的好,可以写的像自然语言一样易懂,可是再自然也还是英语,对于国人普通英文水平较差的程序员而言,还是很不直观的。所以国人要写详尽的注释,来弥补语言文字的理解难度。

举个例子,比如大家方法名都用中文,那么注释量应该能降低不少。