Formatting and standards

CS3398-Mocha-Coffee / -CS3398-Mocha-F2017

0 stars 1 forks source link

Formatting and standards #36

Open aMorneault opened 7 years ago

aMorneault commented 7 years ago

We need to come up with a set of standards and formats to keep our code streamlined and readable. Add what you think would work, with justification. This is an easy couple hours for us to knock out.

aMorneault commented 7 years ago

Here is some good info on style and standards: http://geosoft.no/development/javastyle.html

aMorneault commented 7 years ago

I say every class should be commented at the beginning with the purpose of the class and sub-classes.
All class, object, variable, array list, ect. should be clearly named something readable.
Comment what you think needs to be commented, but do not feel the need to comment every line. If you do something really weird to get around a weird bug. Comment that, with the error you are circumventing so that someone behind you may be able to clean it up.
Stay consistent with indentations, spacing, and things of the like. No real strict standard just make it nice to look at.

aMorneault commented 7 years ago

Those are just a few to start with, if you have any others you want to add. Just put them in here. I will be closing this issue tonight to clean up the hours. If there is something that needs to be addressed after Sprint 1 then we can just take care of it then with a new issue.

aMorneault commented 7 years ago

Keep line length under 100 char.

iabelh commented 7 years ago

Those are good format standards to follow. I have been following similar format, so my code will be understandable. I think we should provide detailed comments on main parts of code like new functions as well.

aMorneault commented 7 years ago

going to mark as done to clean up the hours. If you want to add something. Do it in done, or pull back to in progress then mark as done again.