18 lines
754 B
Text
18 lines
754 B
Text
Maybe we can add some notes here to get a consistent coding experience :)
|
|
|
|
-------------------------------------------------------------------------------
|
|
|
|
comments:
|
|
- should be usable for pydoc
|
|
- ''' or """ at the beginning of every class/method
|
|
- ## for longterm comments, that are useful for understanding
|
|
- #blabla for codelines, that are out for experimenting and might be used later again
|
|
|
|
error handling:
|
|
- unspecific error handling is evil (try: "grep -r except: .")
|
|
|
|
unit testing:
|
|
- first write a unittest and then write the relating code until the unittest stops failing :)
|
|
- 'unittests.ClassName.py' should contain all tests for 'ClassName.py'
|
|
- commits with broken unit tests are evil (fix or disable the code (not the test ;) ))
|
|
|