这是我作业中的一道题:
以下哪项不是可接受的表示评论的方式?为什么?
- /** 评论 */
- /*评论*/
- //评论
- //评论评论
- /*评论评论*/
老实说,我觉得它们都很好。但我在想它可能是/** comment */因为它在示例中不是多行的,但这就是它的目的——文档。你怎么认为? 这是唯一让我感到困难的问题。任何帮助,将不胜感激!谢谢你。
最佳答案
从语法上来说,以上表示注释的方式都不行。 但是,为了让其他人更容易理解您的代码,我建议 遵循一些主要的编码风格。
例如,Oracle coding style 是 Java 流行的编码风格之一。
在它的编码风格中,有两种类型的注释。第一个是实现意见, 它使用/* */用于 block 注释和//用于单行注释。
/*
* Here is a block comment.
*/
// Here is a single line comment.
第二种是文档注释,通常使用/** */风格的注释和 只出现在类、函数和变量定义之前。例如:
/**
* Documentation for some class.
*/
public class someClass {
/**
* Documentation for the constructor.
* @param someParam blah blah blah
*/
public someClass(int someParam) {
...
}
...
}
关于Java 注释困境,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/16574731/