How to document experimental or incomplete APIs like @deprecated?
Is there a good term that is similar but different than “deprecate” to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely change? (Yeah, I know, those methods shouldn’t be public, yada yada yada. I didn’t create my situation, I’m just trying to make the best of it.)
A better JavaDoc? [closed]
As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for […]
Java code documentation in a separate docs file somehow mapped to a source file?
What would be a good alternative to inline Java documentation, i.e. can one have a separate docs file somehow mapped to a java source file?
Deprecated vs. Denigrated in JavaDoc?
In the JavaDoc for X509Certificate getSubjectDN() it states:
@Deprecated as of version x.y in JavaDoc
This question & its answers are useful but not sufficient for my problem.
Preferrable Method to record Documentation
As any taught Software Engineer knows how important Documentation for good software projects is. Could you show me best practices for assure good documentation beside of JavaDoc comments?
Is repeating links to the same class in a single javadoc comment a bad practice?
I’m currently writing an API and its documentation. For example I have something like this:
Is repeating links to the same class in a single javadoc comment a bad practice?
I’m currently writing an API and its documentation. For example I have something like this:
Is repeating links to the same class in a single javadoc comment a bad practice?
I’m currently writing an API and its documentation. For example I have something like this:
Is repeating links to the same class in a single javadoc comment a bad practice?
I’m currently writing an API and its documentation. For example I have something like this: