java - 编码礼节-第一次编程工作

Question

Closed. This question does not meet Stack Overflow guidelines。它当前不接受答案。
                            
                        
                    
                
            
                    
                
                        
                            
                        
                    
                        
                            想改善这个问题吗？ Update the question，所以它是 on-topic，用于堆栈溢出。
                        
                        6年前关闭。
                    
                
        

我刚刚从事过Java编程工作，并且仅在学术环境中或仅凭我自己进行过编程。我想做得很好，并把我的愚蠢问题津贴留给其他技术问题，希望在这里能得到一些帮助。

1）我是否应该评论每一行代码？即使很明显它做了什么，例如
//这会打出愉快的问候
System.out.println（“你好，世界！”）

2）在进行自己的编码时，我经常留下如下注释：

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

要么

//如果该函数可以___，那就太好了。

是否鼓励/允许这些类型的评论（假设它们以专业方式撰写）？或者只是注释，仅用于描述代码的功能。

3）在大学给出的示例代码中，讲师将其姓名，日期等作为注释/标题。这被认为是好的形式吗？还是在吹牛？

助您一臂之力

最佳答案

1）不关你的命。最好的注释是带有可理解标识符的清晰代码。如果代码的某些部分可能不清楚，请对其进行注释。诸如i++; // increases i by 1之类的评论损害了可读性。

注意：“不清楚”是指“不太清楚”。就像在写半傻瓜一样发表评论，因为自从您写它六个月以来，您会觉得自己像个白痴。 （从经验中说出来。）始终假设事物不如您现在想像的那么明显。不过，您不应该在每一行都添加注释。

2）很好。实际上，大多数编辑器都支持NOTE，TODO或XXX之类的标记，因此，即使它们未提取到单独的列表中也可以至少被突出显示，因此，如果将其写为< cc>。

3）如果您使用的是版本控制，并且没有任何不使用版本控制的借口，那么每个人都可以了解每行的编写时间以及编写者。谁启动了文件并不重要。

关于java - 编码礼节-第一次编程工作，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/17668292/

上一篇：java - 我的 getter 返回错误值

下一篇：java - Joda Time 1900年号

相关文章：

java - JFrame 泄漏内存？

java - 以 json 格式写入文件时出错。Stream 已关闭

java - 如何在Java中捕获外部jar的异常

java - 服务器(Python)-使用套接字的客户端(Java)通信

java - 用java分割字符串

Answer 1

1）不关你的命。最好的注释是带有可理解标识符的清晰代码。如果代码的某些部分可能不清楚，请对其进行注释。诸如i++; // increases i by 1之类的评论损害了可读性。

注意：“不清楚”是指“不太清楚”。就像在写半傻瓜一样发表评论，因为自从您写它六个月以来，您会觉得自己像个白痴。 （从经验中说出来。）始终假设事物不如您现在想像的那么明显。不过，您不应该在每一行都添加注释。

2）很好。实际上，大多数编辑器都支持NOTE，TODO或XXX之类的标记，因此，即使它们未提取到单独的列表中也可以至少被突出显示，因此，如果将其写为< cc>。

3）如果您使用的是版本控制，并且没有任何不使用版本控制的借口，那么每个人都可以了解每行的编写时间以及编写者。谁启动了文件并不重要。