如何在eclipse中发表评论？

Question

在日食中发表评论有什么不应该做？ 还有一件事，我正在对我没有制作的源代码进行评论......而且我很难过，因为我也是java的新手。 有小费吗？谢谢:)）

Answer 1

您可以在任意位置使用//和/* ... */条评论 还有/** ... */是JavaDoc注释，
并且可以通过外部工具进行处理以生成
JavaDoc文档。

另请参阅：JavaDoc

Eclipse与否它没关系，这不依赖于IDE。

Answer 2

阅读

10 Best Practices to Follow while writing Code Comments

Answer 3

我强烈推荐Robert C. Martin撰写的“清洁代码 - 敏捷软件工艺手册”

您可以在那里阅读有关dos'和不应该的以下提示的更多信息：

• 评论不能弥补不良代码
• 在代码中解释自己（而不是评论段落）
• 当您可以使用功能或变量时，请勿使用注释
• 好评
• • 法律意见//版权所有（C）2014
• • 信息性评论//返回正在测试的响应者的实例。
• • Intent的说明//在解析期间捕获错误时，我们从列表中返回第一个元素
• • Clarifcation // assertTrue（a.compareTo（a）== 0）; // a == a
• • 后果警告//仅供测试
• • TODO评论// TODO：添加对数组的支持
• 错误评论
• • Mumbling //没有属性文件表示已加载所有默认值
• • 冗余评论//比较a与b
• • 误导性评论//特别是在更新代码并留下描述性评论时
• • 强制评论// @param title CD的标题
• • 期刊评论//您通过SVN，TFS等进行版本控制，无需编写通过评论修改的内容
• • 噪音评论//默认构造函数
• • 注释掉的代码
• • HTML评论
• • 太多信息
• • 不明显的连接//为标题信息添加额外的200
• • 功能标题
• • 非公共代码中的Javadocs