Comments (3)
sguergachi
commented on May 12, 2024
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:
/**
* .------------------------------------------------------------------------.
* | DashboardUI :: Aurora Screen Class
* .------------------------------------------------------------------------.
* |
* | This class contains the UI attached to an appropriate *Handler*
* | and *Logic* class which handle the actions caused by the UI
* | components found here
* |
* | This class must follow the rules stated in the AuroraScreenUI
* | Interface. The *Handler* and *Logic* classes
* | The Handler class is called: DashboardHandler
* | The Logic class is called: DashboardLogic
* |
* |
* |
* .........................................................................
*
* @author sammy <[email protected]> carlos <>
*
*/
/**
* .------------------------------------------------------------------------.
* | DashboardUI()
* .------------------------------------------------------------------------.
* |
* | This is the Constructor of the Dashboard UI class
* |
* | The Constructor of Screen Classes must initialize/create both a
* | Handler and a Logic object which should contain the UI as a parameter
* |
* ..........................................................................
*
* @param auroraCoreUI AuroraCoreUI
* @param startScreenUI StartScreenUI
*
*/
let me know if you like it.
from auroragamehub.
sguergachi
commented on May 12, 2024
Dealing with long lines.
Notice what is placed first in each line, notice the space after the comma, plus or whatever.
- Has commas:
BEFORE:
btnLogout = new aButton("Aurora_Logout_normal.png", "Aurora_Logout_down.png", "Aurora_Logout_over.png", SIZE_btnLogoutWidth, SIZE_btnLogoutHeight);
AFTER:
btnLogout = new aButton("Aurora_Logout_normal.png"
, "Aurora_Logout_down.png"
, "Aurora_Logout_over.png"
, SIZE_btnLogoutWidth
, SIZE_btnLogoutHeight);
- Has commas and other stuff:
BEFORE:
coreUI.getPnlTop().setPreferredSize(new Dimension(coreUI.getPnlTop().getWidth(),coreUI.getPnlTop().getImageHeight()+coreUI.getPnlFrameControl().getHeight()));
AFTER:
coreUI.getPnlTop().setPreferredSize(
new Dimension(coreUI.getPnlTop().getWidth()
, coreUI.getPnlTop().getImageHeight()
+ coreUI.getPnlFrameControl().getHeight()));
- Long If Statments:
BEFORE:
if (storage.getStoredLibrary().getBoxArtPath() == null || storage.getStoredLibrary().getBoxArtPath().isEmpty()) {.
AFTER:
if (storage.getStoredLibrary().getBoxArtPath() == null
|| storage.getStoredLibrary().getBoxArtPath().isEmpty()) {
from auroragamehub.
sguergachi
commented on May 12, 2024
Closing this, comment code you edit or create, overtime we will comment the rest of the codebase
from auroragamehub.
Related Issues (20)
- Shift+Click on Game Cover should allow user to play game HOT 1
- Complete UI for Settings Screen
- Going into an Aurora app sometimes causes multiple "Back" buttons to appear
- Add buttons in add game UI to Steam folder and Program folder
- Clicking Favorite should move game to front page
- Add more Analytic tracking to app via properties and events
- Create Installer that allows for updating and easy install on both Mac and Win
- Add logging to Aurora
- Move AuroraDB to AuroraData folder for installer
- Ability to save game meta data to profileDB
- UI to view game metadata
- Automatically import games from Digital Distributors
- Organize
- Ability to edit Game Path of a game already in a library
- Ability to edit Game Box art for a game already in a library
- Make Auto Add smarter by being able to find best match game cover.
- Ability to edit game cover and use own image from computer instead
- Initial release of Settings UI/Features
- Current LICENSE.TXT restricts user freedoms HOT 1
- Java version? HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from auroragamehub.