OpenSCAD style guide

thingiverse

Revamp your OpenSCAD code using the following style guidelines to enhance readability and maintainability: 1. White space: Utilize appropriate spacing in the right places for improved readability. OpenSCAD, like many other programming languages, ignores white space, granting freedom to arrange code in a legible manner. 2. Indentation: For code blocks (conditionals, loops, modules), indent one level beyond the current indentation using tabs or spaces. This enhances readability. 3. Curly braces: Follow Compact Control Readability Style for placing curly braces. Use open/close curly braces in all cases, even for single-line blocks, to prevent errors. 4. Tabs vs Spaces: Use tabs (not spaces) for indentation as OpenSCAD's editor shortcut uses tabs. However, use spaces to align constants and operators. 5. Grouped code blocks: No need to indent each member of a group if transformations or assignments come in groups (e.g., assign, scale, rotate, translate). Line them up at the same indentation level. 6. Spaces: Use spaces after commas, around colons, and around operators for better readability. A solitary "!" should have a space on both sides. Surround parentheses and brackets with spaces, but not curly braces. 7. Comments: Begin files with a comment block describing the thing, followed by a Thingdoc block. Use /.../ comment blocks before each module for input parameters. Avoid commenting out code; use conditional statements or modules instead. For complex blocks, include comments to describe line purpose. 8. Line Length: Avoid wrapped lines. Modularize code or split lines as needed. 9. Naming Convention: Follow underscore_naming convention for variable naming, keeping them short, unique, and meaningful. 10. Modularization: Keep modules under one page long. Break out code into separate modules if necessary to improve readability and identify reusable code. Remember, "A Foolish Consistency is the Hobgoblin of Little Minds." If any rule hinders readability or maintainability, disregard it in that particular circumstance. The goal is always readability and maintainability.