How do I include Implementation and Usage Documentation in one file
Posted
by
Angelo.Hannes
on Programmers
See other posts from Programmers
or by Angelo.Hannes
Published on 2013-10-11T13:07:33Z
Indexed on
2013/11/10
16:11 UTC
Read the original article
Hit count: 286
documentation
|javadocs
There are two types of documentation.
One type, the Implementation Documentation, contains information about specific implementation of a construct (eg. Class, Method, etc.). It is targeted to the future me, maintainer, debugger and so on.
And there is Usage Documentation, containing information how to use a provided api. It does not contain information about specific implementation and is targeted to users of the api.
How do I include both of them in one file? (Or do I include both of them in one file? And if not, what type belongs into the source file?)
Are there special techniques, using java-doc and/or best practices?
© Programmers or respective owner
