docs(kdoc): 其余模块注释统一为直白说明
把上一提交没覆盖到的模块也改完,至此仓库内不再有"只写编号、不写说明"的注释。 涉及 33 个文件(生产 24 + 测试 9),包括航班状态模型与合并引擎、事件与留痕模型、 运营日计算、投递器、历史归档作业、编解码与身份、重试与重放、健康指示器、 生命周期装配、以及各自的测试类。 改法与前面一致:先说这段代码做什么,再说为什么这么做,术语第一次出现就地解释 (FLID、OPERATION_DAY、航班版本号、删除通知、待发事件表等)。工单编号 (U07/N02/ACM2-10 之类)已全部移除;段落编号只剩 10 处,全部带文件名位于句尾, 用作延伸阅读,例如"见 docs/flight-state.md §5"。 保留了本来就自解释的行内注释、PgTestSupport 顶部的环境变量默认值表格, 以及 InboxController 里描述待补接口的 TODO。 校验:逐文件做"去注释后比对"(块注释 + 行注释清除、空白归一),33 个文件代码 零差异;另做逐行非注释代码比对,同样零差异。clean test 为 78 passed / 1 skipped。
This commit is contained in:
@@ -4,7 +4,8 @@ import com.gzzn.omms.msgexchange.domain.DecodedMessage
|
||||
import com.gzzn.omms.msgexchange.domain.ErrorClass
|
||||
|
||||
/**
|
||||
* ACMA-8 流程 2:解码失败分类(矩阵/状态机:MALFORMED 不重试;CODEC_ERROR 可一键重放)。
|
||||
* 解码失败的结果:错误分类加上一句原因。
|
||||
* MALFORMED 是报文本身不合法、重试也不会过;CODEC_ERROR 是解码逻辑的问题,修好后可以重放。
|
||||
*/
|
||||
data class DecodeFailure(val errorClass: ErrorClass, val detail: String)
|
||||
|
||||
@@ -14,8 +15,9 @@ sealed interface DecodeResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* XML codec:使用 SIS 文档对应的 Jackson XML 注解 DTO,再显式转换为领域载荷;
|
||||
* XMLInputFactory 禁用 DTD/外部实体,原文仍由入站层保留。
|
||||
* XML 解码入口:先用标注了 Jackson XML 注解的 DTO 接住报文体,再显式转成领域模型。
|
||||
*
|
||||
* 解析时关掉 DTD 和外部实体,避免 XML 外部实体注入;报文原文由入站层另行留存,这里不管。
|
||||
*/
|
||||
interface XmlCodec {
|
||||
fun decode(rawXml: String): DecodeResult
|
||||
|
||||
Reference in New Issue
Block a user