How to quote “*/” in JavaDocs

by

Use HTML escaping.

So in your example:

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

/ escapes as a “https://stackoverflow.com/” character.

Javadoc should insert the escaped sequence unmolested into the HTML it generates, and that should render as “*/” in your browser.

If you want to be very careful, you could escape both characters: */ translates to */

Edit:

Follow up: It appears I can use /
for the slash. The only downside is
that this isn’t all that readable when
view the code directly.

So? The point isn’t for your code to be readable, the point is for your code documentation to be readable. Most Javadoc comments embed complex HTML for explaination. Hell, C#’s equivalent offers a complete XML tag library. I’ve seen some pretty intricate structures in there, let me tell you.

Edit 2:
If it bothers you too much, you might embed a non-javadoc inline comment that explains the encoding:

/**
 * Returns true if the specified string contains "*/".
 */
// returns true if the specified string contains "*/"
public boolean containsSpecialSequence(String str)

More Related Contents:

  1. /** and /* in Java Comments
  2. Maven is not working in Java 8 when Javadoc tags are incomplete
  3. Eclipse: Attach source/javadoc to a library via a local property
  4. Why is executing Java code in comments with certain Unicode characters allowed?
  5. Multiple line code example in Javadoc comment
  6. How to generate Javadoc HTML files in Eclipse?
  7. How to see JavaDoc in IntelliJ IDEA? [duplicate]
  8. How to attach source or JavaDoc in eclipse for any jar file e.g. JavaFX?
  9. Java – regular expression finding comments in code
  10. How to reference a method in javadoc?
  11. How to get a JavaDoc of a method at run time?
  12. Remove source file comments using IntelliJ?
  13. How to download Javadoc to read offline? [closed]
  14. How to create custom javadoc tags?
  15. Obtain and download Javadoc (JDK documentation) to a local file for offline reading
  16. Javadoc: package.html or package-info.java
  17. Javadoc reuse for overloaded methods
  18. How to make generated classes contain Javadoc from XML Schema documentation
  19. How can I remove HTML comments in my Facelets?
  20. How do I exclude a specific method/constructor from the results of the javadoc Ant task?
  21. How can I use “” in javadoc without formatting?
  22. Javadoc @author tag good practices
  23. Attaching additional javadoc in Intellij IDEA
  24. How configure Intellij Idea javadoc templates?
  25. A tool to add and complete PHP source code documentation [closed]
  26. Removing all types of comments in java file
  27. How can you escape the @ character in javadoc?
  28. How do I add the Java API documentation to Eclipse?
  29. Flow of class loading for a simple program
  30. Autowiring fails: Not an managed Type

Leave a Comment