🛡️ 良好实践#
Bookshelf 开发强调协作性、清晰度和效率。遵循这些准则可帮助保持代码的高标准:易访问、可理解且非侵入性。
💬 代码注释#
Bookshelf 是一个兼具教育性和可访问性的协作项目,这意味着代码不仅要功能完备,还需对开发者和普通用户同样可理解。
为实现这一目标,定期且清晰地注释代码至关重要:
解释每个函数的目的及其关键组成部分
确保注释简洁但为他人提供充分上下文
功能变更时更新注释以避免混淆
清晰的注释促进更顺畅的协作,并使 Bookshelf 更易于学习。
♻️ 守恒原则#
Bookshelf 遵循受安托万·拉瓦锡格言启发的守恒原则:
“物质不灭,无物创生,万物皆变”
—安托万·拉瓦锡
该原则最大限度减少对分数和其他数据的干扰,旨在防止意外覆盖或不必要操作。
核心准则:#
最小化创建新分数:尽可能复用现有分数
严格避免删除分数:必要时可重新利用分数或重置其值
减少不必要的分数重写:仅在绝对必要时更新分数
每个函数应负责任地处理输入,确保仅改变输出。