UNPKG

bc-code-intelligence-mcp

Version:

BC Code Intelligence MCP Server - Complete Specialist Bundle with AI-driven expert consultation, seamless handoffs, and context-preserving workflows

79 lines (57 loc) 3.87 kB
--- title: "Binary Operator Line Positioning and Code Readability" domain: "roger-reviewer" difficulty: "beginner" bc_versions: "14+" tags: ["code-style", "operators", "readability", "formatting", "line-breaks"] prerequisites: ["al-syntax", "code-formatting"] --- # Binary Operator Line Positioning and Code Readability ## Overview Strategic positioning of binary operators in multi-line expressions enhances code readability by creating clear visual alignment and logical flow, making complex expressions easier to parse and maintain. **Readability Principle**: Position binary operators consistently to create visual patterns that guide the reader's eye through complex logical and mathematical expressions. ## Strategic Framework ### Visual Alignment Strategy - **Leading operators**: Place operators at the beginning of continuation lines - **Consistent indentation**: Align continuation lines for visual clarity - **Logical grouping**: Use operator positioning to show expression hierarchy - **Scanning optimization**: Format for efficient visual parsing of complex conditions ### Expression Flow Design - **Left-to-right reading**: Support natural reading patterns in operator placement - **Precedence clarity**: Use positioning to reinforce operator precedence - **Continuation indicators**: Make line breaks and continuations obvious - **Nested expression handling**: Maintain clarity in complex nested conditions ## Architecture Patterns ### Leading Operator Pattern Place binary operators at the beginning of continuation lines to create clear visual indicators of expression continuation and logical flow. ### Aligned Continuation Pattern Indent continuation lines consistently to create visual columns that make it easy to follow complex multi-line expressions. ### Hierarchical Expression Layout Use operator positioning and indentation to visually represent the logical structure of complex boolean and mathematical expressions. ## Implementation Guidelines ### Formatting Standards - **Operator placement**: Consistently place binary operators at line beginnings - **Indentation depth**: Use consistent indentation for continuation lines - **Spacing consistency**: Maintain uniform spacing around operators - **Line break logic**: Break lines at logical expression boundaries ### Complex Expression Handling Break long expressions at appropriate logical points, using operator positioning to maintain readability and show the relationship between expression parts. ### Tool Integration Configure code formatting tools to apply consistent binary operator positioning rules across the codebase automatically. ## Best Practices ### Consistency Standards - **Team conventions**: Establish and follow team-wide operator positioning standards - **Automated formatting**: Use formatting tools to maintain consistency - **Code review focus**: Include operator positioning in code review criteria - **Style guide documentation**: Document operator positioning rules clearly ### Readability Optimization Format expressions to minimize cognitive load, using operator positioning and alignment to create visual patterns that aid comprehension. ### Maintenance Considerations Choose operator positioning patterns that remain clear and maintainable as expressions grow in complexity over time. ## Anti-Patterns ### Avoid These Approaches - **Inconsistent positioning**: Mixing operator placement styles within the same codebase - **Poor alignment**: Misaligned continuation lines that create visual confusion - **Trailing operators**: Placing operators at the end of lines where they're less visible - **Random line breaks**: Breaking lines without considering logical expression structure - **Ignored formatting tools**: Manual formatting instead of automated consistency