Usage of @see in JavaDoc?

Yeah, it is quite vague.

You should use it whenever for readers of the documentation of your method it may be useful to also look at some other method. If the documentation of your methodA says “Works like methodB but …”, then you surely should put a link. An alternative to @see would be the inline {@link ...} tag:

/**
 * ...
 * Works like {@link #methodB}, but ...
 */

When the fact that methodA calls methodB is an implementation detail and there is no real relation from the outside, you don’t need a link here.

Related Posts:

  1. Is there a way to convert all comments into javadoc comments? [Eclipse/Java]
  2. good example of Javadoc
  3. method in class cannot be applied to given types
  4. HTTP Status 405 – Request method ‘POST’ not supported (Spring MVC)
  5. What does .class mean in Java?
  6. java, get set methods
  7. Javadoc @see or {@link}?
  8. method in class cannot be applied to given types
  9. HTTP Status 405 – Request method ‘POST’ not supported (Spring MVC)
  10. Why nextLine() and not nextString() ?
  11. When is the finalize() method called in Java?
  12. Error: Main method not found in class Calculate, please define the main method as: public static void main(String[] args) [duplicate]
  13. How to return a boolean method in java?
  14. fixing errors on a program to call methods in java
  15. Python-like list comprehension in Java
  16. Java methods getting euclidean distance
  17. How can i fix this equals on primitive type(int)
  18. Details of difference between @see and @inheritDoc
  19. Javadoc @author tag good practices
  20. Return outside method error
  21. Class Declarations for temperature program in Java
  22. What does Java option -Xmx stand for? [duplicate]
  23. How do I convert a String to an int in Java?
  24. What does Java option -Xmx stand for? [duplicate]
  25. Is there an invisible character that is not regarded as whitespace?
  26. Problem with gif with transparent background
  27. Finding white rectangle in an image
  28. 1000 * 60 * 60 * 24 * 30 results in a negative number [duplicate]
  29. How to convert nanoseconds to seconds using the TimeUnit enum?
  30. Search for words with telephone numbers from 2-3-4 tree
  31. Using or ‘|’ in regex [duplicate]
  32. How to format strings in Java
  33. What is the difference between x86 and x64
  34. && (AND) and || (OR) in IF statements
  35. How to use the toString method in Java?
  36. What is a NullPointerException, and how do I fix it?
  37. What exactly is Apache Camel?
  38. Unable to find valid certification path to requested target – error even after cert imported
  39. Unable to find valid certification path to requested target – error even after cert imported
  40. What is the equivalent of the C++ Pair in Java?
  41. Java – Convert integer to string [duplicate]
  42. Getting random numbers in Java [duplicate]
  43. What is an instance variable in Java?
  44. javac is not recognized as an internal or external command, operable program or batch file [closed]
  45. javac is not recognized as an internal or external command, operable program or batch file [closed]
  46. Java: “error: cannot find symbol”
  47. How does the Java ‘for each’ loop work?
  48. What is a StackOverflowError?
  49. How to uninstall Eclipse?
  50. Is GNU’s Java Compiler (GCJ) dead? [closed]
  51. How does System.out.print() work?
  52. How do I “decompile” Java class files? [closed]
  53. How do I determine whether an array contains a particular value in Java?
  54. How to initialize an array in Java?
  55. How does the Java ‘for each’ loop work?
  56. Java 8 Iterable.forEach() vs foreach loop
  57. Initialize part of an array in java
  58. How can I solve Exception in thread “main” java.lang.NullPointerException error [duplicate]
  59. How to split a string in Java
  60. What does “Could not find or load main class” mean?
  61. What does “Could not find or load main class” mean?
  62. Why am I getting a NoClassDefFoundError in Java?
  63. How to avoid “ConcurrentModificationException” while removing elements from `ArrayList` while iterating it? [duplicate]
  64. Eclipse/Maven error: “No compiler is provided in this environment”
  65. How do I compare strings in Java?
  66. Is Java “pass-by-reference” or “pass-by-value”?
  67. What is reflection and why is it useful?
  68. Implementing UML diagram to Java [closed]
  69. How to round a number to n decimal places in Java
  70. Using Pairs or 2-tuples in Java [duplicate]
  71. How do I create a file and write to it?
  72. Could not reserve enough space for object heap
  73. When to use LinkedList over ArrayList in Java?
  74. How to convert a char to a String?
  75. Difference between Arrays.asList(array) and new ArrayList(Arrays.asList(array))
  76. What is the proper way to handle a NumberFormatException when it is expected?
  77. What causes “Unable to access jarfile” error?
  78. What does “Could not find or load main class” mean?
  79. How do you create a dictionary in Java? [closed]
  80. Reading a plain text file in Java
  81. Error unable to access jarfile C:\Jar
  82. Where is JRE 11? [duplicate]
  83. In laymans terms, what does ‘static’ mean in Java? [duplicate]
  84. How to convert/parse from String to char in java?
  85. Reverse a string in Java
  86. Static Classes In Java
  87. Is there any doubly linked list implementation in Java?
  88. How to set a Timer in Java?
  89. How do I declare and initialize an array in Java?
  90. How to parse JSON in Java
  91. Convert list to array in Java [duplicate]
  92. Reverse a string in Java
  93. Sort an array in Java
  94. Java String Split by “|”
  95. Convert String to double in Java
  96. Exception in thread “main” java.util.NoSuchElementException
  97. Is Java “pass-by-reference” or “pass-by-value”?
  98. Could not reserve enough space for object heap
  99. Converting double to string
  100. What is a JavaBean exactly?

Leave a Comment

Hata!: SQLSTATE[HY000] [1045] Access denied for user 'divattrend_liink'@'localhost' (using password: YES)