Code Style

工程代码编写风格指引(不含简单的格式化风格)

pixeval Updated

File contents

代码风格

  • 在重构代码时,不要被既有模式束缚住,直接重构为更合理、更高效的实现;不要作打补丁式的临时修改,并且不要留下兼容代码或过渡方案,避免新旧逻辑混杂。
  • 在关键处留下注释以表达意图。
  • 优先复用现有包和辅助项目、工具类,避免重复造轮子。
  • 保持代码可 AOT 编译,避免使用反射、动态代码,但是若可以用 [DynamicallyAccessedMembers] 避免反射失败则可以使用。
  • 对于相近功能的模型,通过继承、接口、组合等方式复用代码,避免重复代码。
  • 可观测属性优先使用 CommunityToolkit 的 [ObservableProperty] 生成器,并附在部分属性上而不是字段上来生成。

其他

Avalonia XAML

  • 复用主题资源,例如 ControlCornerRadius、TextFillColorSecondaryBrush、SystemAccentColor 等。不要在资源字典外硬编码颜色。
  • 优先复用现已有的转换器和标记扩展,不要临时在 code-behind 里手写格式化。

完成前

  • 对当前改动的文件,运行最小且相关的格式化 / 构建 / 测试命令。

pixeval/ardelle commit 0fdd845aa4

Frequently asked questions

npx get-skill add pixeval/code-style-2