This is an alternative to the standard format of commenting java source codes. Unidoc embodies element-type specific annotations in code commenting.
The annotations include:
> @ModuleDoc
> @PackageDoc
> @ClassDoc
> @InterfaceDoc
> @EnumDoc
> @AnnotationDoc
> @AnnotationMemberDoc
> @ConstructorDoc
> @ParamDoc
> @FieldDoc
> @MethodDoc
The attributes of each annotation match the description and tags of javadoc comments.
An example:
Unidoc format:
@ClassDoc(description = "Class description describes the class." +
"...",
author = "David")
public class ExampleClass {}
javadoc comment:
/**
* Class description describes the class.
* ...
*
* @author David
*/
public class ExampleClass {}
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Also ensure to update appropriate tests.
Author:
Dinneya Charles
Contributors:
David Dinneya