Skip to content

Coding Conventions

Mike Magruder edited this page Aug 23, 2017 · 2 revisions

Basic coding conventions for modifying MonkeyCAM:

  • Line length 80.
  • Indent 2 spaces.
  • Braces on the same line as the function, if, etc.
  • Follow the casing examples already in the codebase.
  • The great truth of most coding conventions: Generally make it look like what's already there.
  • Embrace C++11.

We'll update these over time based on how things go.

Other considerations:

  • Think hard before dragging in new libs and frameworks to depend on.
  • Compile on Mac and Windows.
  • Be efficient; MonkeyCAM is fast now and should remain that way. We should support calling it to generate paths many times a second since we may in fact do that from an app like SnoCAD-X.
Clone this wiki locally