根据罗伯特·C的《整洁代码》,开发者,尤其是初学者,应遵循一些原则:代码应自解释,避免注释和死代码,边界需单元测试,使用正条件,遵循标准架构和命名一致性,避免复杂性,使用异常处理,保持类和方法简洁,遵循“童子军法则”,保持代码整洁。
编写清晰可读的代码比添加注释更重要。通过合理命名变量和函数,使代码自解释,避免重复,遵循Python的优雅原则,确保代码的可读性和简洁性。
本文讨论了代码中何时适合使用注释以及何时不适合。注释应该用于提供上下文,而不是解释逻辑实现。代码应该自解释,通过变量命名和类型来替代注释。注释应该解释为什么代码这样做,而不是代码在做什么。注释被用于解释为什么智能手机没有折扣。注释掉代码是不可取的,可以依赖版本控制系统来恢复代码。TODO注释可以通过CI/CD系统检查并创建问题。注释没有固定的规则,但这些建议可以帮助改善代码编写方式。
完成下面两步后,将自动完成登录并继续当前操作。