PeiyuShi/uber-style-guide-ja

uber-style-guide-ja

About

uber-go/guideの日本語訳

Table of Contents

• 導入
• ガイドライン
  • Pointers to Interfaces
  • Receivers and Interfaces
  • Zero-value Mutexes are Valid
  • Copy Slices and Maps at Boundaries
    • Receiving Slices and Maps
    • Returning Slices and Maps
  • Defer to Clean Up
  • Channel Size is One or None
  • Start Enums at One
  • Error Types
  • Error Wrapping
  • Handle Type Assertion Failures
  • Don't Panic
  • Use go.uber.org/atomic
• Performance
  • Prefer strconv over fmt
  • Avoid string-to-byte conversion
  • Prefer Specifying Map Capacity Hints
• Style
  • Be Consistent
  • Group Similar Declarations
  • Import Group Ordering
  • Package Names
  • Function Names
  • Import Aliasing
  • Function Grouping and Ordering
  • Reduce Nesting
  • Unnecessary Else
  • Top-level Variable Declarations
  • Prefix Unexported Globals with _
  • Embedding in Structs
  • Use Field Names to Initialize Structs
  • Local Variable Declarations
  • nil is a valid slice
  • Reduce Scope of Variables
  • Avoid Naked Parameters
  • Use Raw String Literals to Avoid Escaping
  • Initializing Struct References
  • Initializing Maps
  • Format Strings outside Printf
  • Naming Printf-style Functions
• Patterns
  • Test Tables
  • Functional Options