Coding Standards and Best Practices for Robust Software Development

Introduction: The article discusses the importance of coding standards in large IT companies like Huawei and presents a set of "military rules" for writing robust, maintainable code.

Rule 1: Avoid magic numbers; use meaningful constants.

Rule 2: Each method should have a single responsibility.

Rule 3: Limit method parameters to five.

Rule 4: Do not return null; use exceptions, special‑case objects, or empty collections/arrays.

Rule 5: Ensure resources such as database connections and I/O streams are released in a finally block. Example code:

Connection jdbcConnection = null;

Statement stmt = null;

try {
    // ...
} catch (SQLException e) {
    // ...
} finally {
    if (stmt != null) {
        try {
            stmt.close();
        } catch (SQLException e) {
            logger.log(Level.WARNING, "异常说明", e);
        }
    }
    if (jdbcConnection != null) {
        try {
            jdbcConnection.close();
        } catch (SQLException e) {
            logger.log(Level.WARNING, "异常说明", e);
        }
    }
}

Rule 6: Do not catch generic Exception; handle specific exceptions.

Rule 7: Include an else branch for if‑else if chains and a default case for switch statements to avoid missing branches.

Rule 8: Override hashCode() when overriding equals().

Rule 9: Avoid creating new threads inside loops; use thread pools.

Rule 10: Use BigDecimal or integer arithmetic for precise calculations such as currency.

Additional advice: commit small changes frequently, use meaningful naming, avoid over‑design, keep web applications stateless, prefer logging over breakpoints, limit function size, add concise comments, encourage cross‑review, and communicate promptly when issues arise.

The article concludes with invitations to join a community and provides links to sample SpringBoot projects for further study.