悉思中文模板标签体系规范完成确定,标签以中文命名为主、英文别名并存,参数支持中英双语写法,四类标签的职责边界与书写规则逐项写明。规范确定后,模板调用不再依赖开发者记忆参数拼写,标签的可读性与可校验性同时提高。
标签按作用范围与书写形态分为四类,每类对应固定的使用场景,混用的写法在规范中被明确排除。
| 标签类型 | 作用范围 | 书写形态 |
|---|---|---|
| 全局标签 | 站点信息、时间、配置项 | 单标签直接输出 |
| 循环标签 | 内容列表、栏目列表、标签列表 | 成对包裹循环体 |
| 点号标签 | 当前内容或当前栏目的字段 | 前缀加字段名 |
| 块标签 | 导航、分页、付费区等结构片段 | 成对包裹并带参数 |
分类的直接收益是查错效率:标签写错时按类型定位问题范围,循环标签缺闭合、点号标签字段名写错、块标签参数缺失三类问题都有对应的判定方式。
中文标签名承载语义,英文别名用于习惯英文写法的开发者,两者指向同一处理器。命名遵循含义优先、避免缩写堆叠的原则,标签名由名词或名词短语构成,动词式命名在规范中被排除。
标签由注册表统一登记,登记项包含名称、别名与处理器,新增标签只需增加一条登记而不修改解析流程。注册表同时作为校验依据:未登记的标签在渲染阶段直接跳过,不会把标签原文输出到页面。
注册表机制的另一个作用是把参数校验集中到处理器内部,参数缺失回退默认值,非法取值拒绝执行并记录日志,模板不会因为参数写法错误产生半成品页面。
标签规范、使用文档与标签生成器保持同源维护:文档提供参数说明与示例,生成器提供可视化拼装与复制,两者都从同一份标签定义取值,避免文档与实现出现分歧。
规范要求每个标签都给出参数表与完整示例,示例中的冒号为参数分隔符,展示 HTML 标签写法时尖括号按实体转义,保证文档复制到模板后可直接运行。
中文标签的书写错误需要在渲染阶段被发现,而不是输出到页面后再人工排查。校验规则按四类标签分别定义:全局标签校验名称是否登记,循环标签校验成对闭合,点号标签校验字段名是否在白名单内,块标签校验必需参数是否齐全。
校验失败的处理方式是保留页面其余内容并记录日志:单个中文标签写错不会让整页变成错误页,日志中给出标签名与所在模板路径,定位成本从整页排查降到单条记录核对。模板改版阶段可以按日志清单批量修正,校验规则也与标签生成器的输出保持一致,生成结果天然满足校验要求。校验开关支持按站点关闭,站点在迁移期可以先观察日志再启用拦截,迁移完成后恢复默认拦截策略。
评论
加载中...