Code Cleanup
Efficiency:
-
Ensure that function parameters are const * where it would improve the code. -
Avoid copying objects that need not be copied. -
Check for / Fix memory leaks -
Other miscellaneous improvements -
Fix all compiler warnings (in debug mode, warnings for unused variables that only appear in assertions are ok)
Cleanup:
-
Remove unused variables -
Remove unused functions -
Remove commented out code -
Remove redundant qDebug() outputs -
Remove redundant comments
Readability:
-
Ensure all variables follow naming convention -
Base Mesh handles starting with a b -
Meta Mesh handles starting with a m -
Vertex handles including vh (bvh/mvh/bvhit...) -
Halfedge handles including heh -
Edge handles including eh -
Face handles including fh
-
-
Function names capitalized and names explaining functionality -
Variables names lower case and explaining functionality -
Doxygen style pre-function comments explaining functionality -
Reasonable ordering of functions in the header; eg. clustering of functions belonging together thematically. -
Ordering of functions in the .cc files to resemble order in .hh files.
Edited by Jan Schnathmeier