编码礼仪 - 第一次编程工作

时间:2013-07-16 04:53:05

标签: java etiquette

我刚刚从事Java编程工作,并且只在学术环境中编程,或者只是自己编程。我想做好工作,并为更多的技术问题保存我的愚蠢问题,所以希望我能在这里得到一些帮助。

1)我是否希望评论每一行代码?即使它的作用非常明显,例如 //这会打印出愉快的问候语 System.out.println(“Hello,world!”)

2)在进行自己的编码时,我经常留下以下评论:

//如果您有时间,请使用大型数据集使此代码更好地扩展

//如果此功能可以 _ __ ,那就太棒了。

是否鼓励/允许这些评论(假设它们是以专业的方式编写)?或者只是对代码所做内容的描述的注释。

3)在大学提供的示例代码中,讲师将他们的姓名,日期等作为评论/标题。这被认为是好形式吗?或者试图吹嘘?

为你的帮助干杯

2 个答案:

答案 0 :(得分:3)

1)不是你的生活。最好的评论是明确的代码,可以理解标识符;如果代码的某些部分可能不清楚,请对其进行评论。像i++; // increases i by 1这样的评论会损害易读性。

注意:“不清楚”,我的意思是“不完全清楚”。留下评论,好像你写的是一个半白痴,因为从你写这篇文章六个月后,你感觉自己像个半白痴。 (从经验中说出来。)总是认为事情并不像你现在认为的那么明显。不过,你不应该评论每一行。

2)那些都很好。事实上,大多数编辑都支持NOTETODOXXX这样的代码,因此如果甚至没有在您可以浏览的单独列表中提取,那么它们至少会突出显示,因此它很棒如果你像// TODO make it scale better with large data sets那样写。

3)如果您正在使用版本控制,并且没有理由不使用版本控制,那么每个人都可以找出每个特定行的编写时间以及由谁编写。谁开始这个文件是微不足道的。

答案 1 :(得分:0)

仅仅根据我的经验和我所看到的:

1)不是每一行都应该被评论,但是评论可能会在以后出现任何问题,或至少评论至少如果你以后回来的地方,你会知道你在做什么,并在思考时间。

2)如果不是正式版本,我会留下这些,然后至少在你自己的副本中,这样你才能知道你想对项目做什么。那些并不重要。

3)是的,这些对版本控制非常重要。