日期:2014-05-19  浏览次数:20691 次

|javamy| myEclipse 有没有办法给变量添加注释
Java code

          /**
     * 取得一个StatelessSession
     * 
     * @return
     */
    public static StatelessSession getStatelessSession() {
                  //添加一个变量 这里为他的注释
                  int i = 0;
                  i =  i + 1; //如果鼠标在这里i悬停,如何能出上面定义i的注释?
        return sessionFactory.openStatelessSession();
    }


如上面的
/**
*
*/
可以为类或方法添加注释和类定义的变量实现注释
那用什么方法可以经类方法里面的变量做注释呢?

谢谢

------解决方案--------------------
Java code
/**
     * 测试用变量
     */
    private String ddd;

------解决方案--------------------
楼主这是通过csdn来学java了?

变量的注释还是可以通过
/**
*
*/
来注释

比如:

Java code
class Class1{
    public void fun(){
        String s = Class2.str; //把鼠标放在str上也是有提示的。
    }
}

class Class2{
    
    /**
     * from Class2 string
     */
    public static String str = "1234";
}

------解决方案--------------------
只是方法内的局部变量一般不需要这样注释,局部变量也就方法内有效,其它地方也调用不到。
------解决方案--------------------
好像可以自己设置模板。
------解决方案--------------------
注释信息都是Java语言规范中有所定义的,其主要目的是为了开发集成过程中,各模块、类可以自我解释其函数和变量。

但是并没有为局部变量定义JavaDoc标准,所以楼主你的期望暂时是没法实现的了。

不过,换个角度而言,楼主你的需求其实是没有很高合理性的:
1、单个函数的内部并不需要多人协作开发,所以并不需要这种类似于JavaDoc的参考能力;
2、函数的长度是有限的,比如不应超过 50 行,超长函数是违反编码规范的;短短50行内,确实也没有太大必要对这些局部变量定义出很详细的说明;
3、单个函数内部职能应该足够简单,否则就需要用多个函数来解构,所以也不应该出现大量的局部变量从而导致不详细说明根本看不懂的情况。

总的来说,普通注释已经够用了:
int i = 0; // 这个i准备用来计数