评论＆amp;开源软件

Question

这可能听起来像是一个愚蠢的问题或观察，但我已经看到，大多数时候，当一个人试图查看开源代码时，在函数开始时没有注释或只有一两行该功能用于什么，例如在表等中注册用户或数据。没有代码可以实际解释功能正在做什么等。

当代码发布到开源社区以使其他人难以理解时，是否故意（删除评论）？

Answer 1

有一种思路认为，当代码说明问题时，评论是不必要的。不过，我不相信会有意删除评论。

Answer 2

我见过双方，坦率地说代码没有充分记录。

我已经被祝贺并感谢您留下了大量的面包屑，但那是因为我必须筛选太多未记录的代码才能让其他任何人接受它。

称之为道德义务。

我记录代码的原因：我的短期记忆是垃圾。我写评论提醒自己为什么我做了什么。从中受益的每个人都是肉汁。

Answer 3

我认为在将软件作为开源软件发布时，有一种做法或政策可以删除评论。一个鬼鬼祟祟的软件发行商可能认为这是一个好主意（保持事实上的排他性，因为在发布开源产品时没有人无法理解它），但这会使开源项目从一开始就瘫痪，并且最有可能使其无法使用。

您所谈论的代码可能只是很少记录。正如ocdecio所说，这可能是一个好兆头（代码说明并且不需要评论）或者是一个坏的（它是严重记录的，错误的代码）。两种情况都是完全可能的。 :)

Answer 4

你在比较什么？

我怀疑封闭源代码有更好的评论。

至于什么功能，可能有API文档。无需在评论中复制这些内容。

Answer 5

作为一项规则，功能应该足够小，并且可以通过阅读它们来完成如何的工作。在描述内容的函数顶部发表评论有助于在阅读整个源代码文件时快速概述函数本身（除非函数名称不言自明）。

许多项目以这种方式组织，这很棒。

但是，在尝试找到更大的代码库时，我常常忽略的是描述大图片，即一般架构，原则，什么在哪里以及类似的东西。

Answer 6

所有开源都不一样。这就是我们所说的概括。

如果你看一下跟踪现有大量开源软件的网站Ohloh，它会描绘出一幅截然不同的画面：

http://www.ohloh.net/languages?query=&sort=code

例如，在C语言中，有2.52亿行注释，每5行C中约有1个是注释。对于Java，近三分之一的行是评论。那还不错。

Answer 7

开源软件大多数时候都有糟糕的评论和错误的文档。有各种原因，有些原因比其他原因更好。通常它们与懒惰或开发者在当下的存在有关。没有任何理由是良好的原因。