信息的 一类用户 需要知道应该进入Javadoc注释。
修改类 的 开发人员 需要知道的信息放入常规注释(块或行)。
并且,当需要公开可见的内部代码以及内部文档时,任何代码块(类,接口,字段,方法,构造函数等)都可能 同时 具有Javadoc注释和普通注释块。
就我个人而言,我倾向于编写很少的非Javadoc注释,因为我更喜欢以自我记录的方式来构造代码。
欢迎分享,转载请注明来源:内存溢出
信息的 一类用户 需要知道应该进入Javadoc注释。
修改类 的 开发人员 需要知道的信息放入常规注释(块或行)。
并且,当需要公开可见的内部代码以及内部文档时,任何代码块(类,接口,字段,方法,构造函数等)都可能 同时 具有Javadoc注释和普通注释块。
就我个人而言,我倾向于编写很少的非Javadoc注释,因为我更喜欢以自我记录的方式来构造代码。
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)