language-agnostic - 评论做法?

标签 language-agnostic comments

作为计算机工程专业的学生,​​我受到压力要对我所做的每件事都进行非常详细的评论。我可以看到这对于小组项目或工作场所非常有用,但是当您处理自己的项目时,您会花费大量时间发表评论吗?

作为一个我正在从事的个人项目,它变得越来越复杂,有时我似乎应该发表更多评论,但我也觉得这是浪费时间,因为我可能是唯一从事此工作的人。值得花时间和混乱的代码吗?

有什么想法吗?

编辑:这给了我很多思考。感谢您的输入!我没想到会有如此大的回应。

最佳答案

当代码无法执行时,经过深思熟虑的注释会亮起。经过深思熟虑的函数和变量名称消除了对大量注释的需求。如果您发现有必要注释所有内容,请考虑简化代码。

关于language-agnostic - 评论做法?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/2760026/

相关文章:

multithreading - 一个程序怎么可能只包含线程安全的类,但不是线程安全的?

python - 为什么 python 在注释中使用非常规的三引号?

language-agnostic - GPGPU 是黑客吗?

language-agnostic - 创建公交路线

visual-studio-2010 - 将指向另一个文件 (Word) 的超链接插入到 Visual Studio 代码文件中

javascript - 我不明白这段类似 Javascript 注释的代码,有人可以澄清一下吗?

html - 在 HTML 文件中显示 HTML 注释字符串 (<!-- -->)

c# - 引用文件的 XML 注释

创建学校时间表的算法

terminal - 为什么默认终端宽度是 80 个字符?