iris-code-formatter

🛡️ IRIS代码智能审查与一键格式化

基于东华医为IRIS代码规范,对InterSystems IRIS ObjectScript代码进行格式化检查、审查和自动修正,涵盖命名、锁、事务、注释等8大维度规范。

收藏
5.2k
安装
1.1k
版本
1.0.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心能力

该技能是一套专业的InterSystems IRIS ObjectScript代码规范检查与格式化工具,基于东华医为内部制定的IRIS代码规范开发。覆盖变量命名、方法命名、锁规范、事务规范、陷阱规范、格式规范、空行规范、注释规范8大核心维度,提供代码审查、问题标记、自动修正和合规建议等完整能力。

显著优点

权威性:基于医疗信息化龙头企业东华医为的内部生产规范,经过大规模项目验证,规则细致且实战性强。

完整性:覆盖ObjectScript开发全生命周期,从变量命名(lowerCamelCase/UpperCamelCase)、Global命名规则,到事务控制(ts/tc/tro简写)、锁管理(必须带+/-和超时)、错误处理(陷阱命名与开放性事务防护)均有明确规定。

可操作性:提供详细的速查表、代码示例对比、系统命令/函数缩写对照表,支持自动格式化修正,输出结构化审查报告。

工程化导向:强调方法行数控制(≤50行)、循环内禁止SQL、事务近距离原则、代码可读性优先等工程实践。

潜在局限

  • 企业特定性:规范绑定东华医为内部实践(如^TMP临时global格式、产品组代码锁命名),通用IRIS项目需适配调整。
  • 未完全自动化:当前描述偏重规则文档,实际自动修正能力依赖具体实现,复杂重构场景(如方法拆分)需人工介入。
  • 版本兼容性:未明确说明支持的IRIS版本,部分缩写规则可能因版本差异需要调整。

适合人群

  • InterSystems IRIS/ObjectScript开发工程师
  • 医疗信息化领域(HIS/EMR)后端开发者
  • 需要统一团队代码规范的Tech Lead
  • 进行IRIS代码审查的QA工程师

常规风险

  • 过度格式化风险:自动修正可能改变代码语义,建议审查后人工确认。
  • 规范冲突:与其他IRIS社区规范(如InterSystems官方风格)可能存在差异,混合使用需谨慎。
  • 锁与事务误用:规范中锁超时、事务配对等规则执行不当时可能导致数据一致性问题。

iris-code-formatter 内容

references文件夹
手动下载zip · 8.7 kB
coding_standards.mdtext/markdown
请选择文件