问答详情
源自:2-12 如何在Java中使用注释

javadoc问题

javadoc为什么要生成,有什么作用,在什么情况下需要生成?有哪位大神能不能详细介绍一下javadoc到底是怎么回事,谢谢。

提问者:慕斯1379455 2017-05-17 21:22

个回答

  • 太阳_50
    2017-05-17 22:27:56

    当我们的项目很大,编写了很多代码的时候,就需要生成一个标准的API文档,让后续的开发人员,或者合作者可以清晰的了解您方法的使用.

    打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/

    javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。