What is the best source code (comment)?

发表于2009年11月28日, 星期六此文属于 技术体会

我脑子里有个一个问题:世界上最好的源代码是什么呢?于是我用Google搜了一把“What is the best source code”,但是Google并没有了解我的真实意图,回答的是“What is the best source code comment”。good_bad_code

搜索结果第一条来自于我最喜欢的技术讨论网站stackoverflow.com,这个讨论的发起者就是stackoverflow的创始人。从讨论的内容来看,大家说的其实也不是“最佳源代码注释”,而是“最让人抓狂的源代码注释”,我相信每个程序员在生涯中都见过这样的注释。

我也曾见过几个很厉害的注释,不吐不快。

/// <summary>

/// Create a Writer.

/// <summary>

public SomeReader CreateReader() {

    ......

}

到底是创建一个Reader?还是创建一个Writer?

这是一个叫Li Xiang的程序员写的代码和注释,如他所说,因为他实在想不出一个有意义的标识符来命名这个变量,于是就用了自己的名字。

// I don't know how to name this variable.

bool xiang = ...;

相关文章:

  1. WordPress 2.9 发布
  2. SEO写作
  3. Chrome Frame in IE:这是个狠招
  4. Chrome Frame性能测试
  5. 开源软件不会比“闭源”软件安全?

分享到: 开心网 豆瓣网 人人网 Google书签 Del.icio.us

 

目前已有一篇评论,还有板凳可坐

  1. sandy说:

    morgan,你好,我在网上看到你的一个问题:The Most Efficient Way To Find Top K Frequent Words In A Big Word Sequence http://stackoverflow.com/questions/185697/the-most-efficient-way-to-find-top-k-frequent-words-in-a-big-word-sequence

    现在我也遇到一个同意的问题,但是稍微有点不同:我的源数据文件大概有1G多,内存要求限制在100M以内,所以你描述的步骤1的优化对我很重要,这个问题我想了很长时间,觉得用先切分再单独统计的方法比较靠谱,但是就是对源文件的切分还没有想到一个比较一般的算法,不知道你后来对这个问题有没有更好的solution,希望回复指教。

    [回复]

我来评论两句