Skip to main content
added 17 characters in body
Source Link
Dave Newton
  • 160.5k
  • 27
  • 263
  • 310

@see creates an isolated line in the Javadocs. {@link} is for embedding within text.

I use @see when it's a related entity but I don't refer to it in the expository text. I use links within text when there's tight coupling, or (I feel) it's likely the reader would benefit from additionalthe navigation hint, e.g., you'll need to reference it directly.

@see creates an isolated line in the Javadocs. {@link} is for embedding within text.

I use @see when it's a related entity but I don't refer to it. I use links within text when there's tight coupling, or (I feel) it's likely the reader would benefit from additional navigation.

@see creates an isolated line in the Javadocs. {@link} is for embedding within text.

I use @see when it's a related entity but I don't refer to it in the expository text. I use links within text when there's tight coupling, or (I feel) it's likely the reader would benefit from the navigation hint, e.g., you'll need to reference it directly.

Source Link
Dave Newton
  • 160.5k
  • 27
  • 263
  • 310

@see creates an isolated line in the Javadocs. {@link} is for embedding within text.

I use @see when it's a related entity but I don't refer to it. I use links within text when there's tight coupling, or (I feel) it's likely the reader would benefit from additional navigation.