This project is an application skeleton. It is used for a HKUST Software Engineering Course (COMP3111/H) in Fall 2016/17. My goal: The project is not asking students to re-produce the sample project. We should encourage students to do something better than the TA.
In order to ensure the readability, extensibility and maintainability of codes, we should unify the programming style to ensure everyone should understand the codes in direct way. The following things we need to know about:
Variable name, function:
Variable names should be direct and clear, avoid using symbols and make use of Capital letters. Don't name the variables in abstract way.
Spacing(the length of white space)
The recommended length of space is 4. Spacing is important to show how the codes are elaborated.
The comments of complicated logic or algorithm involved
Comments are needed to make sure other people can understand your logic and flows.
If you have any ideas of programming styles, please raise your ideas. Thanks.
In order to ensure the readability, extensibility and maintainability of codes, we should unify the programming style to ensure everyone should understand the codes in direct way. The following things we need to know about:
If you have any ideas of programming styles, please raise your ideas. Thanks.