+ 2

What is external documentation of your source code?

It is related to java comments' part

18th Sep 2020, 11:13 PM
Reza - avatar
4 Answers
+ 5
You probably mean javadoc. https://en.m.wikipedia.org/wiki/Javadoc It is a utility that will take the comments you put over your classes and methods, from the source code, and automatically generates static html pages from them that describe your API. Same as the official java documentation. https://docs.oracle.com/en/java/javase/15/docs/api/index.html For this to work, your comments must be written in specific format and using special keywords like @param @return @throws and so on.
19th Sep 2020, 4:06 AM
Tibor Santa
Tibor Santa - avatar
+ 2
In my experience, it’s usually a README file explaining how to install and configure your code, as well as which arguments/options can be passed to the executable file. It could also include an example of the code’s expected output. They can sometimes explain how the code’s functions work, but I personally just leave those as comments in the source code.
18th Sep 2020, 11:16 PM
NULL - avatar
+ 2
What are you asking? Please be more clear with your question, thanks.
18th Sep 2020, 11:17 PM
Rowsej - avatar
+ 1
Can you have a look to session java-comments-document comments and javadoc and est.
18th Sep 2020, 11:30 PM
Reza - avatar