1:制定API的时候,一定要考虑到参数类型、方法返回类型和所能抛出的异常,由于API改动的代价非常大,因此一定要考虑清楚,API要考虑后续的扩展,一个方法的内部实现是可以随意变化的,只要保证实现向后兼容就行,但暴露出来的API一般就不可能再去变了。
2:制定xml格式的时候,能用属性最好不要用text,因为属性用dtd/schema容易约束,而text则不好或不能约束。
群内tank给的例子:
<contact>
<name>张三</name>
<email>xxx@example.com</email>
</contract>
换成,方便程序读取
<contract>
<property name="name" value="张三" />
<property name="email" value="xxx@example.com" />
</contract>
或者,方便DTD/SCHEMA,读取的话也不是很麻烦
<contract name="张三" email="xxx@example.com" />
第一种格式最差,标签没规律,程序不方便统一读取;最后一种如果加一个attribute,那么必须要告知读取程序这个attribute的name;中间的方式,加一个attribute,则格式都是相同的。
用text还有一个坏处:
<name>张三</name>
<name>
张三
</name>
后者,有的框架读出来是"张三",有的读出来是"\r\n张三\r\n"
多谢tank.
分享到:
相关推荐
阿里巴巴开发规范 一、编程规约 1 (一) 命名规约 1 (二) 常量定义 3 (三) 格式规约 4 (四) OOP 规约 6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 15 (八) 注释规约 16 (九) 其它 17 二、异常日志...
NET 开发规范(参考阿里开发规范),
Vue前端开发规范
医保信息系统安全开发规范。本规范用于规范和统一医疗保障信息系统生命周期各阶段(包括:安全需求分析、系统安全设计、 系统开发安全、系统安全测试和系统部署上线等阶段)需执行的安全控制及安全任务,明确系统...
参考阿里巴巴开发规范整理
阿里前端开发规范.pdf
阿里开发规范最新,2021年
Hive开发规范及要点,hql 开发基础知识,规范
阿里开发规范插件,可以嵌入到eclipse中,检测代码规范性
阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴...
前端开发规范文档_pdf文件,开发规范命名相关,提高代码的阅读能力,以及规范性,团队协作能力,前端必备技能之一。
OA界面开发规范OA界面开发规范OA界面开发规范
c# Winform应用程序开发规范c# Winform应用程序开发规范c# Winform应用程序开发规范
Net开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.ppt
共61页,划分为编程规约、异常日志、 单元测试、 安全规约、 MySQL 数据库、 工程结构、 设计规约七个维度,再根据内容特征,细分成若干二级子目录。涉及到大多数开发规范的约定。
国家标准-软件开发规范文档,28个文档 1.任务申请.doc 2.可行性与计划阶段--可行性研究报告.doc 2.可行性与计划阶段--项目开发计划.doc 2.软件质量保证计划编写规范.doc 3.数据要求说明书编写规范.doc 3.软件需求说明...
GB8566-88 计算机软件开发规范 目的:详细规定计算机软件开发过程胡各个阶段及没法儿阶段胡任务、 实施步骤、实施要求 、完成标志及交付文件。为软件开人员和管理人员提供一系列之有效的准则、方法和规范。
Web前端开发规范手册
hive常用的开发规范 hdfs hbase udf函数 hql shell脚本开发等常用规范,仅供参考