This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Classes are documented #26
Labels
Comments
Here are some points we should apply from the Google's Java Style Guide
/**
* Multiple lines of Javadoc text are written here,
* wrapped normally...
*/
public int method(String p1) { ... }
/**
* First paragraph goes here
*
* <p>Second paragraph goes here
*
* @param p1 Description of p1 goes here
*/
public int method(String p1) { ... }
|
Here are some points we should apply from Oracle's How to Write Doc Comment:
Tags
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
All classes and methods should be documented with Javadoc.
A Javadocs guideline/standard should be decided before starting this task.
The text was updated successfully, but these errors were encountered: