文章目录

M通用版代码规范 - 持续更新
变量
方法
类
锁
事务
陷阱
格式
空行
注释

M通用版代码规范 - 持续更新

变量

代码中的命名均不能$、#等特殊符号开始或结束，因为$、#等是系统方法、变量，禁止混淆。

反例：

$name
_name

正例：

name

严禁代码中使用拼音与英文混合方式命名，更不允许直接使用中文。

反例：

Dazhe
getDZname
[打折]

正例：

discount
getDiscountName

参数名、成员变量、局部变量都统一使用lowerCamelCase风格。

反例：

Params

正例：

params

常量命名全部大写。力求完整语义表达清楚，不要嫌长。

反例：

MaxCount = 10

正例：

MAXCOUNT = 10

杜绝不规范缩写，避免词不达意。

反例：

com
condi

正例：

complete
condition

长度为7个以内单词不需要缩写，当变量长度过长时需考虑缩写，且缩写应为常用正规缩写，避免无意义缩写。

反例：

st
nb

正例：

start
number
num

避免无意义变量。

反例：

s a = "1"
s b = "2"
s c = a * b

正例：

s fitstNum = "1"
s secondNum = "2"
s sum = firstNum * secondNum

临时global、进程global命名严格使用^TMP、^||TMP，且携带pid。格式为领域名 + 类名 + 方法 + pid + 标识。

提前把TMP开头的global名称配置到临时TEMP命名空间，配置不写日志。

反例：

s ^||YX("TMP", pid, "Login")

正例：

s ^||TMP("IRIS", "IRIS.MOB.Base", "Login", pid)

布尔变量不要用is开头，因为其他框架引用的话会解析错误。例如Java的Getter的方法也叫isDisp()。

反例：

isDisp

正例：

dispFlag

所有表的ID，都用表的前缀。

反例：

BS_IRIS_Student：ID
CF_IRIS_Config：configID

正例：

BS_IRIS_Student：bis
CF_IRIS_Config：cic

所有引用global数据的变量，用表ID + data方式命名，多节点用ID + 节点 + Data方式。

反例：

s data=^BS.IRIS.StudentD(inci)

正例：

s bisData = ^BS.IRIS.StudentD(inci)

方法中仅出现一次dataStr分割字符串分割索引均为i长度均为len。

反例：

s prescNolen=$l(prescNoStr, ",")
f index = 1 : 1 : len q:ret'=0  d
.s prescNo = $p(prescNoStr, ",", index)

正例：

s len = $l(prescNoStr, ",")
for i = 1 : 1 : len {s prescNo = $p(prescNoStr, ",", i)
}

创建的私有对象可以加m，例如有Execute类的初始化对象。

反例：

s execute = ##(IRIS.Execute).%New()

正例：

s mExecute = ##(IRIS.Execute).%New()

不要将系统保留字或SQL保留字做为变量。

反例：

s SQLCODE="0"

正例：

s code = "0"

对于调用其他方法获取返回值的变量，禁止使用err的名称，推荐ret。

反例：

s errRet=##class(XXX).Save()
s retErr=##class(XXX).Save()

正例：

s ret = ##class(XXX).Save()

禁止变量超过31个字符。（局部变量名称限制为31个字符。可以指定长度超过31个字符的名称，但仅使用前31个字符。）

示例：

ClassMethod Var()
{s abcdefghiklmnopqrstuvwxzy123456789 = "1"w abcdefghiklmnopqrstuvwxzy123456789,!s fitst = 1s fitstSum = fitst +abcdefghiklmnopqrstuvwxzy123456789w fitstSum,!s second = 2s abcdefghiklmnopqrstuvwxzy1234567891 = "2"w abcdefghiklmnopqrstuvwxzy1234567891,!s secondSum = second + abcdefghiklmnopqrstuvwxzy123456789w secondSum,!b
}

结果：

DHC-APP>d ##class(M82).Var()
1
2
2
4b }^
<BREAK>zVar+11^M82.1
DHC-APP 2d1>w<Private variables>
abcdefghiklmnopqrstuvwxzy123456=2
fitst=1
fitstSum=2
second=2
secondSum=4

百分比变量命名要以%z开头，避免与系统变量冲突。

反例：

s %msg = ""

正例：

s %zXX("XX") = ""

.inc文件里的通用变量，为了防止与系统变量重复。加上前缀标识。

反例：

#define Error "XX"

正例：

#define XXError "XX"

方法

类名、方法名使用UpperCamelCase风格。

反例：

BS.iris.student
getname()

正例：

BS.IRIS.Student
GetName()

返回布尔类型方法以Is开头,例如是否存在。ture为$$$YES,false为$$$NO,方法后面加上 As %Boolean。

反例：

GetExistFlag()

正例：

ClassMethod IsExist(name) As %Boolean
{s bis = $o(^BS.IRIS.StudentD("Student", name, ""))q:(bis '= "") $$$YES    q $$$NO
}

调用：

if(..IsExist(name)){// todo
}

q:..IsExist(name)

q:'..IsExist(name)

推荐使用动宾结构，函数名应清晰反应函数的用途和功能。

反例：

ObtainName()

正例：

GetName()

函数，方法名最长不超过30个字符。

反例：

DefineDeliveryProcessEvent()

正例：

SetDispEvent()

每个方法对应一个词 retrieve 、fetch、 find、 query 都有查询意思，manager、handler、controller都有管理之意。我们只规定一种。查询就Query，获取数据就Get。

反例：

ObtaionSomething()
RetrieveSomething()

正例：

GetSomething()
QuerySomething()

一个方法尽量控制在50行（一屏）。如果过于庞大，就该重构。庞大的方法容易引起阅读疲劳，让人抓不住重点。代码逻辑要分主次，个性，共性。

反例：

ClassMethod Login(params)
{s info =""f  s info = $o(^IRIS("info", info)) q:info="" d.s flag = $p(^IRIS("info", info), "^", 1).i flag = "Y" d.sql(insert .....)
}

正例：

ClassMethod Login(params)
{s info =""for {s info = $o(^IRIS("info", info))q:(info = "")s flag = $p(^IRIS("info", info), "^", 1)s ret = ..IsFlag(flag)continue:(ret)}
}
ClassMethod IsFlag(flag) as %Boolean
{if flag = "Y" {s ret = ..InsSomeThing()q:(ret '= 0) $$$NO}q $$$YES
}
ClassMethod InsSomeThing(flag)
{sql(insert .....)
}

方法内传递参数过多。考虑用对象方式来重构。

反例：

ClassMethod Login(params)
{s startDate = $p(params, "^" ,1)s endDate = $p(params, "^" ,2)s locID = $p(params, "^" ,3)s userID = $p(params, "^" ,4)s groupID = $p(params, "^" ,5)s ret = ..DoSomeThing(startDate, endDate, locID, userID , groupID)
}
ClassMethod DoSomeThing(startDate, endDate, locID, userID , groupID)
{s status = $o(^IRIS("Flag",flag,""))s other = $o(^IRIS("userID",userID,""))s flag = $o(^IRIS("flag","")s ret = ..DoSomeThingSub(startDate, endDate, locID, userID , groupID, flag , status, other)
}
ClassMethod DoSomeThingSub(startDate, endDate, locID, userID , groupID, flag , status, other)
{//to do
}

正例：

ClassMethod Login(params)
{s mLogin = ##class(PHA.OP.MOB.Login).%New()s mLogin.startDate = startDates mLogin.endDate = endDates mLogin.locID = locIDs mLogin.userID = startDates mLogin.groupID = groupIDd mLogin.Login()
}
Class IRIS.Login
{//各种属性
}

禁止在循环里直接写sql语句即&sql()，应把sql单独提出成方法。

禁止在公共查询里写涉及存储sql方法。
sql语句应当单独建立类来保存，给予其他类调用。

反例：

ClassMethod Login(params)
{s info =""f  s info = $o(^IRIS("info", info)) q:info="" d.s flag = $p(^IRIS("info", info), "^", 1).sql(insert .....)
}

正例：

ClassMethod Login(params)
{s info =""for {s info = $o(^IRIS("info", info))q:(info = "")s flag = $p(^IRIS("info", info), "^", 1)s ret = ..InsSomeThing(flag)}
}
ClassMethod InsSomeThing(flag)
{sql(insert .....)
}

非普通字符串的入参或返回值需要进行声明，以明确数据类型，如数组、对象、流、引用，%Status等数据类型。

反例：

/// desc: 入参为引用,返回为数组
classmethod Test(Param)
{}

正例：

/// desc: 入参为引用,返回为数组
classmethod Test(ByRef param) As %ArrayOfDataTypes
{}

当遇错误信息时，返回值不能单纯的返回负数，不能使用大于等于0的数值作为错误信息的标识。

字符串形式：负数^错误信息的格式

q "-1^代码重复"

json形式:

q ..RetFail("代码重复")

/// w ##class(M.M83).Save()
ClassMethod Save()
{s ret = ..InsData()q:(ret.code < 0 ) ret.msgq $$$OK
}ClassMethod InsData()
{q ..RetFail("代码重复")
}ClassMethod RetFail(msg)
{s obj = {}s obj.code = -1s obj.msg = msgq obj
}

%Status形式：

q $$$ERROR($$$GeneralError,"代码重复")

/// w ##class(M.M83).SaveStauts()
ClassMethod SaveStauts() As %Status
{s sc = ..InsDataStauts()q:$$$ISERR(sc) $System.Status.GetOneStatusText(sc)q $$$OK
}ClassMethod InsDataStauts() As %Status
{q $$$ERROR($$$GeneralError,"代码重复")
}

类

全部类以IRIS.XX开头。

反例：

Class XXX.XXX.XX

正例：

Class IRIS.XXX.XX

所有类里的方法，方法顺序按照常用顺序排序，最常用的最在上，依次。
类默认均为ProcedureBlock，禁止Not ProcedureBlock，如需使用特殊字符@等，单独建类或方法并定义Not ProcedureBlock。

反例：

Class IRIS.Login Extends %RegisteredObject  [not ProcedureBlock]

正例：

Class IRIS.Login Extends %RegisteredObject

锁

禁止直接锁表结构的Global。

反例：


l +^BS.IRIS.StudentD

加解锁必须加+、-严格控制，必须成对出现。

反例：


l +^BS.IRIS.Student(1)
l +^BS.IRIS.Student(1)l -^BS.IRIS.Student(1)

正例：

l +^BS.IRIS.Student(1):3
l -^BS.IRIS.Student(1):3l +^BS.IRIS.Student(1):3
l -^BS.IRIS.Student(1):3

加锁必须要带+，否则导致解锁进程内所有锁。

反例：


l +^BS.IRIS.Student1(1)
l +^BS.IRIS.Student2(1)
l ^BS.IRIS.Student3(1)

正例：

l +^BS.IRIS.Student1(1):3
l +^BS.IRIS.Student2(1):3
l +^BS.IRIS.Student3(1):3

加锁必须写超时的退出，避免死锁，造成进程无限期阻塞。

正例：

l +^BS.IRIS.Student:3

自定义功能锁：^产品组代码(产品线,规范代码:唯一标识)（例如：单号）。

反例：

l ^TMPOP(lockName)

正例：

l +^IRIS("BIZ", "BOXNO:" _ boxNo):5

私有进程全局变量名不能用作锁名。

反例：

l +^||BS.IRIS.Student(1):3

正例：

l +^BS.IRIS.Student(1):3

禁止单独在程序中使用无参数锁。

反例：

lock

使用锁时一定要下标节点。

反例：


l +^BS.IRIS.Student

正例：

l +^BS.IRIS.Student(1):3

事务

严格禁止开放性事务。

反例：

ClassMethod Save()
{tstart
}

正例：

ClassMethod Save()
{tstc //或 tro
}

事务ts、tc、tro的位置应保持近距离，在一屏幕范围内，避免位置过远。代码过多应当提取成方法，让事务看起来简洁、语义明朗。

反例：

ClassMethod Save()
{ts/* 添加主表信息 */// todo 50行代码/* 添加明细信息 */// todo 100行代码tc
}

正例：

ClassMethod Save()
{ts/* 添加主表信息 */s sc = ..InsMain()i $$$ISERR(sc) troq:($$$ISERR(sc)) sc/* 添加明细信息 */s sc = ..InsDetail()i $$$ISERR(sc) troq:($$$ISERR(sc)) sctcq sc}

严格禁止跨方法提交事务。

反例：

ClassMethod Save()
{tss sc = ..InsMain()}
ClassMethod InsMain()
{// todotc
}

正例：

ClassMethod Save()
{tss sc = ..InsMain()tcq sc
}ClassMethod InsMain() as %Status
{// todo
}

为明确显示事务，事务命令需要简写并且小写。

反例：

ClassMethod Save()
{TSTART...TCOMMIT
}

正例：

ClassMethod Save()
{ts... // todotc
}

同一个方法内不应该出现事务嵌套的现象。

反例：

ClassMethod Save()
{tsts... // todotrotc... // todotstc
}

正例：

ClassMethod Save()
{ts... // todotc
}

事务应在保存程序的最外层。

反例：

ClassMethod Save()
{tss sc = ..InsMain()s sc = ..InsDetail()tc
}ClassMethod InsMain() as %Status
{ts// todotc
}ClassMethod InsDetail() as %Status
{ts// todotc
}

正例：

ClassMethod Save()
{tss sc = ..InsMain()i $$$ISERR(sc) troq:($$$ISERR(sc)) scs sc = ..InsDetail()i $$$ISERR(sc) troq:($$$ISERR(sc)) sctc
}ClassMethod InsMain() as %Status
{// todoq sc
}ClassMethod InsDetail() as %Status
{// todoq sc
}

单条SQL语句的数据保存不需要事务。

反例：

ClassMethod Save()
{ts&&sql()tc
}

正例：

ClassMethod Save()
{&&sql()
}

ts,tc 首尾添加空行，或者注释.。

反例：

ClassMethod Save()
{TSTARTs ret=..SaveMain()...s retItm=..SaveDetail()...TCOMMIT
}ClassMethod SaveMain()
{TSTART...TCOMMIT
}ClassMethod SaveDetail()
{TSTART...TCOMMIT
}

正例：

ClassMethod Save()
{ts/* 注释 */s ret = ..SaveMain()i ret < 0 tro q.../* 注释 */s ret = ..SaveDetail()i ret < 0 tro q...tc
}ClassMethod SaveMain()
{...
}ClassMethod SaveDetail()
{...
}

陷阱

严格禁止陷阱内部报错导致死进程。

反例：

/// d ##class(M.M87).Save()
ClassMethod Save()
{s $zt = "Error"Errors color = redq $ze
}

正例：

/// d ##class(M.M87).Save()
ClassMethod Save()
{s $zt = "Error"Error// 禁止写业务逻辑q $ze
}

如果类为Not ProcedureBlock ,陷阱名称统一为 Err + 方法名。

反例：

ClassMethod Save()
{s $zt="Save"...
Save...
}

正例：

ClassMethod Save()
{s $zt="ErrSave"...
ErrSave...
}

默认类陷阱名称统一为Error，注意通用陷阱写法。

ClassMethod CommonZtrap() As %String
{s $zt = "Error"// todo  q ""
Errors $zt = ""  /* 避免死循环 */i $tl >0 tro  /* 避免开放性事务 */lock   /* 避免开放锁 */q $ze
}

格式

方法大括号一律换行显示。

反例：

SetDispEvent(){}

正例：

SetDispEvent()
{}

以下符号添加空格，美观代码，=、 +、 -、 *、 /、 _、 : 左右加空格，,之后加空格。

反例：

GetName(hour,number,year)
{s name=“yaoxin”s day=hour*numbers sub=$o(^IRIS("DATE",day,hour,""))
}

正例：

GetName(hour, number, year)
{s name = “yaoxin”s day = hour * numbers sub = $o(^IRIS("DATE", day, hour, ""))
}

方法内命令行均采用一个制表符tab缩进，宽度为四个空格宽度。注意是一个tab键，而不是按四次空格，可在studio设置（默认为4）

反例：

GetName(hour,number)
{   s name=“yaoxin”s day=hour*numbers sub=$o(^IRIS("DATE",day,hour,""))
}

正例：

GetName(hour, number)
{s name = “yaoxin”s day = hour * numbers sub = $o(^IRIS("DATE", day, hour, ""))
}

SQL语句一行5个字段。并且换行后3个tab键为准。逗号在每行行末，不要带入下行开始。因为一行字符书不超过120个，即一屏。

注意：sql命令全部统一小写。

反例：

ClassMethod InsBox(str As %String) As %Library.String
{&SQL(Insert Into DHC_PHBox (PHB_No, PHB_Num, PHB_Status, PHB_FLoc_Dr,PHB_TLoc_Dr,PHB_UserCreate_Dr,PHB_DateCreate, PHB_TimeCreate, PHB_PrintFlag, PHB_Remark) values(:boxNo, 1, :status, :fromLocID, :toLocID,:userID, :date, :time, "Y", :remark))q SQLCODE
}

正例 insert：

ClassMethod InsBox(str As %String) As %Library.String
{&SQL(insert into DHC_PHBox (PHB_No, PHB_Num, PHB_Status, PHB_FLoc_Dr, PHB_TLoc_Dr,PHB_UserCreate_Dr, PHB_DateCreate, PHB_TimeCreate, PHB_PrintFlag, PHB_Remark) values(:boxNo, 1, :status, :fromLocID, :toLocID,:userID, :date, :time, "Y", :remark))q SQLCODE
}

正例 update：

ClassMethod UpdMenu(arg...) As %Library.String
{&sql(update CT.IMP.Menu set CIM_Name = :name, CIM_Path = :path, CIM_Component = :component, CIM_Icon = :icon, CIM_OrderNum = :numCIM_Status = :status,where ID = :ID)q SQLCODE
}

正例 delete：

ClassMethod DelMenu(arg...) As %Library.String
{&sql(delete BS_PHA_IN.BarCode where ID = :ID)q SQLCODE
}

单行字符串拼写最多5个字段。因为一行字符书不超过120个，即一屏。

反例：

ClassMethod GetString(str As %String) As %Library.String
{s str = first _ second _third _ fourth _ fifth _six
}

正例：

ClassMethod InsBox(str As %String) As %Library.String
{s str = $lb("first", "second", "other", 4, "71")s str = str _ $lb("y", "x", "what", "apple", "sum")s str = $lts(str, "^")w str
}

禁止用同一变量后加数字累加。

反例：

ClassMethod GetString(str As %String) As %Library.String
{s str1 = first _ second _ third _ fourth _ fifth s str2 = sixs str = str1 _ str2
}

正例：

ClassMethod GetString(str As %String) As %Library.String
{s str = first _ second _ third _ fourth _ fifth s str = str _ six
}

获取多返回值用数组%ArrayOfDataTypes或JSON点语法或其他对象数组，不建议使用字符串拼接形式。

反例：

ClassMethod GetPatLocDesc(prescNo)
{s str = wardID _ "^" _ wardLocDR _ "^" _ patLocDesc q str
}

正例：

ClassMethod GetPatLocDesc(prescNo)
{s array = ##class(%ArrayOfDataTypes).%New()d array.SetAt(wardID, "wardID")d array.SetAt(wardLocDR, "wardLocDR")d array.SetAt(patLocDesc, "patLocDesc")q array
}

正例：

ClassMethod GetPatLocDesc(prescNo)
{s obj = {}s obj.wardID = wardIDs obj.wardLocDR = wardLocDRs obj.patLocDesc = patLocDescq obj
}

禁止系统命名混搭方法中出现s和 set 统一用命名缩写方式。

反例：

ClassMethod GetPatLocDesc(prescNo)
{s str = “wardID”set patLocDesc = “病区”do ..GetName()q str
}

正例：

ClassMethod GetPatLocDesc(prescNo)
{s str = “wardID”s patLocDesc = “病区”d ..GetName()q str
}

禁止命令出现大小写，统一小写。

反例：

ClassMethod GetName(userID)
{s name=“yaoxin”S age=30
}

正例：

ClassMethod GetName(userID)
{s name = “yaoxin”s age = 30
}

尽量使用对仗词。

add/remove
open/close
get/set
start/end
insert/delete
show/hide
lock/unlock
first/last
next/previous
old/new

禁止{}和.同时出现,推荐用使用块级语法，抛弃使用点语法。并且括号要对齐。

反例：

ClassMethod GetName(userID)
{i flag="yx" d.i other = "other"{s name = “other” }.s name = "yx"
}

正例：

ClassMethod GetName(userID)
{if flag="yx" {if other = "other" {s name = “other” }s name = "yx"}
}

如果if语句只有一行，建议使用三元运算符。所有if语句都要换行写，即使只有一行。

反例：

i name="yx" s age=30
e s age=0

正例：1

i name = "yx" {s age = 30
} else {s age = 0
}

正例：2

s age = $s(name = "yx" , 1 : 0)

if 嵌套不宜过多，建议不超过3层。

反例：

i name = "yx" d
.s state = 30
.i gender = "男" d
..s state = 20
..i age = "年轻人"
...s state = 10
e  d
.s state =0

正例：用策略模式或状态模式封装。

多级if else 考虑用@case替换。

反例：

i day =1 d
.s desc = "Monday"
e  i day =2 d
.s desc = "Tuesday"
e  i day =3 d
.s desc = "Wednesday"

正例：

$CASE(day,1:"Monday",2:"Tuesday",3:"Wednesday",4:"Thursday",5:"Friday",6:"Saturday",7:"Sunday",:"entry error"
)

与或逻辑运算统一使用&&、||，禁止使用其他&、!、,。

反例：

s firstName = "Yao"
s lastNmae = "Xin"
if firstName = "Yao",lastNmae = "Xin"
.w "true",!
e  d
.w "false",!

正例：

 s firstName = "Yao"s lastNmae = "Xin"i (firstName = "Yao")&&(lastNmae = "Xin") {w "true",!} else {w "false",!}

块级语法命令要全拼。例如for，if命令在块语法中不要缩写，这样语义更强。

反例：

ClassMethod Login()
{s info =""f  s info = $o(^IRIS("info", info)) q:info="" d.s flag = $p(^IRIS("info", info), "^", 1).i flag = "1" d..// todo
}

正例：

ClassMethod Login()
{s info = ""for {s info = $o(^IRIS("info", info))q:(info = "")s flag = $p(^IRIS("info", info), "^", 1)if (flag) {//to do }}
}

后置表达式要加括号,并且等号两侧加上空格。保持风格统一。

反例：

q:info=""

正例：

q:(info = "")

空行

方法与方法之间进行空行隔断。(1个空行)

反例：

Method GetName()
{...
}
Method GetAge()
{...
}

正例：


Method GetName()
{...
}Method GetAge()
{...
}

空行用来分割功能相似，逻辑内容，意思相近的代码片段，使程序布局更加清晰。

反例：

ClassMethod Execute(params)
{s $zt="ErrExecute"s prescNo = $p(params, ..#Del, 1)s exeCode = $p(params, ..#Del, 2)  s userID = $p(params, ..#Del, 3)s locID = $p(params, ..#Del, 4)TSTARTs mExecute = ##class(PHA.DEC.MOB.Execute).%New(prescNo, exeCode, userID, locID)s ret = mExecute.Execute()i ret '= 0 TROLLBACKq:(ret '= 0) ..RetFail(ret)TCOMMITs rows = ..GetPrescDetail(prescNo)s objectJson = ..GetPrescData(prescNo)s objectJson.rows = rowsq ..RetObject(objectJson)
ErrExecuteq ..RetFail($ze)
}

正例：

ClassMethod Execute(params)
{s $zt="Error"s prescNo = $p(params, ..#Del, 1)s exeCode = $p(params, ..#Del, 2)   s userID = $p(params, ..#Del, 3)s locID = $p(params, ..#Del, 4)tss mExecute = ##class(PHA.DEC.MOB.Execute).%New(prescNo, exeCode, userID, locID)s ret = mExecute.Execute()i ret '= 0 TROLLBACKq:(ret '= 0) ..RetFail(ret)tcs rows = ..GetPrescDetail(prescNo)s objectJson = ..GetPrescData(prescNo)s objectJson.rows = rowsq ..RetObject(objectJson)Errorq ..RetFail($ze)
}

基于第2点，空行之前添加行注释也要空行，并且行注释/* 规则 */。

注意：*空格的位置。

反例：

ClassMethod Execute(params)
{s $zt="ErrExecute"s prescNo = $p(params, ..#Del, 1)s exeCode = $p(params, ..#Del, 2)  s userID = $p(params, ..#Del, 3)s locID = $p(params, ..#Del, 4)TSTARTs mExecute = ##class(PHA.DEC.MOB.Execute).%New(prescNo, exeCode, userID, locID)s ret = mExecute.Execute()i ret '= 0 TROLLBACKq:(ret '= 0) ..RetFail(ret)TCOMMITs rows = ..GetPrescDetail(prescNo)s objectJson = ..GetPrescData(prescNo)s objectJson.rows = rowsq ..RetObject(objectJson)
ErrExecuteq ..RetFail($ze)
}

正例：

ClassMethod Execute(params)
{s $zt="Error"/* 获取入参 */s prescNo = $p(params, ..#Del, 1)s exeCode = $p(params, ..#Del, 2) s userID = $p(params, ..#Del, 3)s locID = $p(params, ..#Del, 4)/* 执行方法 */tss mExecute = ##class(PHA.DEC.MOB.Execute).%New(prescNo, exeCode, userID, locID)s ret = mExecute.Execute()i ret '= 0 TROLLBACKq:(ret '= 0） ..RetFail(ret)tc/* 获取json */s rows = ..GetPrescDetail(prescNo)s objectJson = ..GetPrescData(prescNo)s objectJson.rows = rows/* 返回json */q ..RetObject(objectJson)Errorq ..RetFail($ze)
}

事务首尾先后一定要加空行或注释，代表强调。

反例：

Method SaveSomething(params)
{s ret = $$$NOts...//to dotcq ret
}

正例：

Method GetName()
{s ret = $$$NOts...//to dotcq ret
}

注释

句首注释用/* */ ，句尾注释用// ，头注释用/// ，注意各类注释后应跟空格。

反例：

// desc: 获取名称
///Input:        用户ID
ClassMethod GetName(userID)
{//获取参数s userID = $p(params, "#", 1)  ;用户ID
}

正例：

/// desc: 获取名称
ClassMethod GetName(params)
{/* 获取参数 */s userID = $p(params, "#", 1) // 用户ID
}

避免无意义注释，尽量用规范的代码命名语言去描述。不要浪费大量时间在毫无意义的注释上。简明扼要，不要啰嗦，注释应当画龙点睛。

反例：

/// Description: 获取名称
/// Input:       用户ID
ClassMethod GetName(userID)
{}

正例：无须注释。

ClassMethod GetName(userID)
{}

所有类加上创建者和日期，创建者应为姓名的全拼，避免出现yx等简写或其他英文名，并简易说明类用途。

反例：

Class IRIS.MOB.API Extends IRIS.MOB.Biz

正例：

/// desc: 煎药室接口
/// author：yaoxin
/// date：2022-08-12
Class IRIS.MOB.API Extends IRIS.MOB.Biz

避免错误注释误导。可能由于复制过来方法，没有改注释。这样的注释后期开发人员困惑性极大。

反例：

/// Description: 获取年龄
/// Input:       科室ID
ClassMethod GetName(userID)
{}

正例：

ClassMethod GetName(userID)
{}

方法的完整注释，关于接口中的方法以及存储数据核心方法(如门诊发药)，应给与完整注释以及修改记录等。

/// desc:        住院是否存在未退药,提前退费已退
/// author:      name
/// date:        2022-09-12
/// params:      name - 姓名, age - 年轻
/// retrun:      输出说明
/// version:     V7~V8.3+
/// caller:      医生，护士，计费
/// modify:      增加急诊留观判断, 2020-02-01, name
/// debug:       w ##class(XXX).XX(xxx)

类和方法注释保持对齐公正。

反例：

/// desc:       住院是否存在未退药,提前退费已退
/// author:    name
/// date:     2022-09-12
/// params:  name - 姓名, age - 年轻
/// retrun:  输出说明
/// version:   V7~V8.3+
/// caller:  医生，护士，计费
/// modify:      增加急诊留观判断, 2020-02-01, name
/// debug:       w ##class(XXX).XX(xxx)

正例：

/// desc:        住院是否存在未退药,提前退费已退
/// author:      name
/// createDate:  2022-09-12
/// params:      name - 姓名, age - 年轻
/// retrun:      输出说明
/// version:     V7~V8.3+
/// caller:      医生，护士，计费
/// modify:      增加急诊留观判断, 2020-02-01, name
/// debug:       w ##class(XXX).XX(xxx)