nol-alb / 6106Group4

0 stars 0 forks source link

Coding Style Specification & Documentation #9

Open med1844 opened 2 years ago

med1844 commented 2 years ago

We need to explicitly record how would we write code. I have run into memory leakage and juce said we should use RIAA techniques (e.g. unique_ptr, OwnedArrays, ReferenceCountedObjects). We need to record such kind of best practice that we are going to follow. We should also specify which coding style we are going to write in (e.g. Google C++ Style. There are coding style checkers available and we should look into it and pick one to formulate and standardize our code. One example is clang-format. For easier cooperation, we need documentation tools. We can use doxygen, but I don't know if there is good template of theme kind of things to generate modern look pages.

Please feel free to add if you find anything interesting! We might add this into Insights -> Community Standards -> Code of conduct.