Feature #896
Feature #890: Code Development Page
Think of Coding Style Guidelines
Added by Tomas BRAND SASTRE over 1 year ago.
Updated over 1 year ago.
Due date:
12/21/2023 (about 17 months late)
Description
Decide on some sort of
coding guidelines to follow during the development process.
- If you aren't lazy as sloths, try to briefly write some of the main guidelines on a document and post it somewhere. (I will think of an environment to share documentation between members)
Tomas Brand (PM)
Files
- Subject changed from Coding Style to Think of Coding Style Guidelines
- Assignee set to Shuto TAMAOKA
- Estimated time set to 1.50 h
- Due date set to 12/21/2023
Some fundamental coding guidelines added by Yuta Hirahata
- % Done changed from 0 to 70
In addition to yuta's guideline, I suggest these rules.
- Don't use global variables
- Use concise name for variables
- 4 tabs for indentation
- Use snake case for function and variable names
- Use upper case camel for class names
I think you don't have to add your name to the part you edited. Because there will be your name everywhere.
For those who don't know what snake case and low camel case, they are like this.
Snake case is as followings. All characters are lowercase and words are separated by under bar.
def some_func():
pass
img_width = 100
img_height = 100
Upper case camel is like below. All first character of the word will be uppercase.
class MyClass()
Any suggestions are welcome.
Sorry I meant 4 spaces for indentation.
Also available in: Atom
PDF