Warning: file_get_contents(/data/phpspider/zhask/data//catemap/3/sockets/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
/*(非javadoc)含义_Java_Syntax_Comments_Javadoc - Fatal编程技术网

/*(非javadoc)含义

/*(非javadoc)含义,java,syntax,comments,javadoc,Java,Syntax,Comments,Javadoc,可能重复: 以下陈述是什么意思 /* (non-Javadoc) * * Standard class loader method to load a class and resolve it. * * @see java.lang.ClassLoader#loadClass(java.lang.String) */ @SuppressWarnings("unchecked") Javadoc查找以/**开头的注释。 按照

可能重复:

以下陈述是什么意思

    /* (non-Javadoc)
     * 
     * Standard class loader method to load a class and resolve it.
     * 
     * @see java.lang.ClassLoader#loadClass(java.lang.String)
     */
    @SuppressWarnings("unchecked")

Javadoc查找以/**开头的注释。 按照传统,不打算成为java文档一部分的方法注释以“/*(非Javadoc)”开头(至少在您的开发环境为Eclipse时)

另外,避免在方法内部使用多行注释。例如,避免以下情况:

public void iterateEdges()
{
  int i = 0;

  /* 
   * Repeat once for every side of the polygon.
   */
  while (i < 4)
  {
  } 
}
public void iterateEdges()
{
int i=0;
/* 
*对多边形的每一侧重复一次。
*/
而(i<4)
{
} 
}
首选以下各项:

public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
    ++i;
  } 
}
public void iterateEdges()
{
int i=0;
//对多边形的每一侧重复一次。
而(i<4)
{
++一,;
} 
}
原因是您打开了注释整个方法的可能性:

/*
public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
     ++i;
  } 
}
*/

public void iterateEdges()
{
  // For each square edge.
  for (int index = 0; index < 4; ++index)
  {
  }
}
/*
public void iterateEdges()
{
int i=0;
//对多边形的每一侧重复一次。
而(i<4)
{
++一,;
} 
}
*/
public void iterateEdges()
{
//对于每个正方形边缘。
对于(int-index=0;index<4;++index)
{
}
}

现在,在实现新方法时,您仍然可以看到旧方法的行为。这在调试时也很有用(以简化代码)。

这只是一个普通的注释。注释的意思是,如果您创建一个基于javadoc的手册,则不会添加此文本。

当程序员要求Eclipse在[EDIT:Eclipse认为]javadoc工具实际不会使用的位置向某些代码添加javadoc注释时,我看到了Eclipse生成的这条消息

一个常见的例子是在类实现的接口中实现方法(在Java 6中需要@Override注释)。Javadoc将使用放置在接口中方法上的Javadoc,而不是实现中提供的Javadoc


其余的评论很可能是一个不知道这一点的人写的。

@Freiheit感谢您的编辑。区别现在好了。@Tom,不必让程序员失望了。在Java编程中,成为所有相关技术的专家几乎是不可能的。实际上,如果您使用
/**
提供注释,则将使用它来代替接口方法。(即使没有使用,也可以在源代码中使用它,这样在阅读源代码时有好处。)感谢@PaŭloEbermann提供的宝贵提示!多么多余的惯例啊我总是想删除这些Eclipse生成的注释,因为它们有时在许多简单类的文本内容中占很大比例,但没有提供任何好处。它们不传递任何合理的IDE或程序员的常识无法推断的信息(它有一个@Override注释,我知道在哪里可以找到它的JavaDocs…。@simpleuser,因为(我假设)它放在其他地方的“真实”doc注释。
/*
public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
     ++i;
  } 
}
*/

public void iterateEdges()
{
  // For each square edge.
  for (int index = 0; index < 4; ++index)
  {
  }
}