编写注释意味着在Java中“无所事事”的常见做法是什么?

时间:2012-12-12 11:19:37

标签: java exception comments

我有下一个代码:

InputStream is = new FileInputStream("test.txt");
// do something
try {
    is.close();
} catch(IOException ex) {
    // do nothing
    // or
    // NOP
    // or something else?
}

问题是Java世界中是否有任何约定表示什么都不做?就像在我的情况下,如果无法关闭InputStream,我想什么都不做。 “NOP”评论是否可以接受?它来自Assembler,意思是“无操作”。

4 个答案:

答案 0 :(得分:6)

try {
    ...
} catch (IOException ignored) {}

完整,清晰,简洁。


但你应该使用像Apache Commons IO IOUtils.closeQuietly(InputStream)这样的东西。

答案 1 :(得分:3)

这并不重要,虽然我比其他人更频繁地看到NOP,但没有明确的约定。对我来说,重要的是标记为什么你忽略了异常。我个人更喜欢“// NOP - 解释”风格,例如

//NOP - If we can't read this input file it doesn't matter as next block will try another

答案 2 :(得分:2)

没有标准的方法,甚至没有标准说你必须在那里发表评论。如果有一个指南,它将符合贵公司的编码标准。如果没有,请使用您喜欢的任何内容。

我只能说一件事。 确保清楚你的意思。

答案 3 :(得分:1)

我所知道的没有惯例。我通常把//传递给python语句。