-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Code needs to be commented #8
Comments
Ok, so here is the multi line comment wrapper I think we should use. Simple title, max of 2 paragraphs to be used for main methods. Just copy and paste, the spaces have been put in place so editing shouldn't be necessary.
Here is an example of what it should look like:
let me know if you like it. |
Dealing with long lines.Notice what is placed first in each line, notice the space after the comma, plus or whatever. - Has commas:BEFORE:
AFTER:
- Has commas and other stuff:BEFORE:
AFTER:
- Long If Statments:BEFORE:
AFTER:
|
-Moved random game generator in Dashboard UI to Logic -Renamed all DashboardUI size fields and getters and setters to convention -More refactoring of loadUI and buildUI in DashboardUI
- Cleaned DashboardLogic commenting - Refactored all variables for AuroraCoreUI - Removed unnecessarily commented stuff in AuroraCoreUI - Added some comments to varibles of AuroraCoreUI - Added CONTRIBUTING markup doc for coding style documentation
-AuroraApp commented and refactored - Implemented new AuroraScreenHandler and AuroraScreenLogic to classes - some cleaning here and there - added more stuff to CONTRIBUTING.md
Closing this, comment code you edit or create, overtime we will comment the rest of the codebase |
We need to add comments to code following this: http://antjanus.com/blog/web-design-tips/best-comment-separator/
The text was updated successfully, but these errors were encountered: