iris-code-formatter

🔧 IRIS代码规范审查与自动格式化

基于姚鑫总结的IRIS代码规范,提供InterSystems IRIS ObjectScript代码的自动化格式化、规范审查与修正,涵盖命名、事务、锁、格式等8大维度

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

使用说明

核心能力

本技能专注于InterSystems IRIS ObjectScript代码的规范化处理,由姚鑫基于多年IRIS开发实践总结而成。技能覆盖变量命名、方法命名、锁机制、事务管理、陷阱处理、格式规范、空行规范、注释规范八大维度,提供代码审查与自动修正能力。

显著优点

1. 体系化规范:建立了从命名到事务完整的代码规范体系,包含具体的缩写规则(如s代替set)、空格规范(运算符两侧加空格)、结构规范(方法50行以内)
2. IRIS专属优化:针对IRIS特性设计,包括Global命名规范(^TMP临时变量)、进程变量(^||TMP)、事务简写(ts/tc/tro)、锁超时机制(:3)

3. 安全导向:特别强调事务和锁的安全性,禁止开放性事务、要求锁必须成对出现、陷阱必须防止死循环

4. 实用速查:提供完整的命令/函数缩写对照表,便于开发者快速查阅

潜在局限

  • 个人经验总结:规范基于作者个人实践,非InterSystems官方标准,可能存在组织适配性问题
  • 版本兼容性:未明确标注适用的IRIS版本范围,部分规则可能随版本变化
  • 自动化程度:当前为规则文档形态,自动化修正能力依赖外部实现

适合人群

  • IRIS/ObjectScript开发团队需要统一代码风格
  • 新团队成员快速熟悉项目规范
  • 代码审查自动化工具开发者

常规风险

  • 严格缩写规则可能影响代码可读性(尤其对IRIS新手)
  • 事务和锁的强制规范可能改变原有代码执行逻辑,需谨慎验证

iris-code-formatter 内容

references文件夹
手动下载zip · 16.6 kB
代码规范 - 事务.mdtext/markdown
请选择文件