Javadoc @link references in Android Studio

前端 未结 3 1449
遇见更好的自我
遇见更好的自我 2021-02-02 09:08

I\'m trying to generate some Javadocs with Android Studio. I\'m referring with {@link #method()} a method in the same class as the link but I still get a refe

相关标签:
3条回答
  • 2021-02-02 10:03

    In Android Studio within a javadoc comment, try typing {@ and then hitting ctrl+space to see what pops up...

    After choosing link, hit space.

    Now try ctrl+space again for a list of all possible classes.

    To just make a reference to a method/data within the current class, type # and then ctrl+space to see a list of probably-what-you-want.

    Don't forget to make sure the brackets are closed!

    0 讨论(0)
  • 2021-02-02 10:10

    The format for the javaDoc lint tag in Android Studio is:

    {@link package.class#member label}
    

    Here is more information on javaDoc tags.

    0 讨论(0)
  • 2021-02-02 10:13

    I don't know if anyone is still struggling with it but if you are and {@link is not working then make sure your comment block looks something like this

    /**
    * {@link 'your reference'
    */
    

    make sure that the comment block starts with two * and not one, apparently, this works for me in the android studio.

    0 讨论(0)
提交回复
热议问题