Skip to content

Instantly share code, notes, and snippets.

@tech-andgar
Created August 20, 2017 19:57
Show Gist options
  • Save tech-andgar/507c21de2bffaaf8d9ae3802017e080f to your computer and use it in GitHub Desktop.
Save tech-andgar/507c21de2bffaaf8d9ae3802017e080f to your computer and use it in GitHub Desktop.
DOCUMENTATION COMMENT IN JAVA
Note: [Change name or description] -> []
/*
*<h3>LICENSE</h3>
* <p>
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details at
* https://www.gnu.org/copyleft/gpl.html
*/
// import statements
import java.*;
/**
* <h2>[TitleProject]</h2>
* <p>
* <b>[FirstName LastName]</b>
* <a href="mailto:[example@email.com]">&lt;[example@email.com]&gt;</a>
* <br><i>[TitleProfession]</i>
* <p>
* [Info Additional]
* <p>
* <b>Objective:</b> [Objective]
* <br><b>Description:</b> [Short Description]
*
* @author [FirstName LastName] <a href="[mailto:example@email.com]">&lt;[example@email.com]&gt;</a>
* <br>[TitleProfession]
* @version 0.1 [2017-08-16]
* @since [2017-08-16]
* @see <a href="https://[webPage]">[Link]</a>
*/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment