Code cleanup, compareMS2 - Githubissues

524D / compareMS2

Compare samples by MS2 spectra

MIT License

3 stars 0 forks source link

Code cleanup, compareMS2 #20

Closed magnuspalmblad closed 2 years ago

magnuspalmblad commented 2 years ago

Now that the software more or less does what it is supposed to, it is a good time to clean up the code, including:

making variable names are descriptive (simple iterators may be an exception)
ensuring variable names in code are similar to their name in the GUI and the theoretical description of compareMS2
using Camel case for functions and variables, Pascal case for structs, Snake case for constants
dividing the code into blocks corresponding to the different steps
providing clear and descriptive comments above each block, and after each non-trivial line

Anything else?

magnuspalmblad commented 2 years ago

Done - see new C code magnuspalmblad/compareMS2. Since this affects the GUI bindings, I will let you decide when to fetch the new version of the compareMS2 executable.