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.
分享到:
相关推荐
"阿里前端开发规范" 阿里前端开发规范是阿里巴巴集团为其前端开发者所制定的开发规范,旨在提高开发效率、代码质量和团队协作。该规范涵盖了前端开发的各个方面,包括命名规范、HTML 规范、CSS 规范等。 命名规范 ...
阿里巴巴前端开发规范.docx 阿里巴巴前端开发规范是阿里巴巴集团为了确保前端开发的质量和统一性而制定的规范。本规范涵盖了前端开发中的多个方面,包括命名规范、HTML 规范、CSS 规范等。 命名规范 命名规范是...
Vue前端开发规范 一、前端开发规范的重要性 在前端开发过程中,遵循规范是至关重要的。它不仅影响代码的维护和理解成本,而且在团队协作中至关重要。规范的目的是统一团队的代码风格,提高代码的可读性和降低维护...
《前端开发规范手册合集》是一份集合了前端开发各个层面规范的综合资源,旨在提升团队协作效率,保证代码质量,以及实现项目的可维护性和可扩展性。这份压缩包包含了以下主要内容: 1. **前端开发基本规范**:这...
Java后端开发规范是指导Java开发者遵循的一套标准和最佳实践,旨在提高代码质量、可维护性、可扩展性和团队协作效率。这份"java后端开发规范word文档"包含了多个方面的内容,包括但不限于编程风格、命名规则、异常...
为了促进规范的普及,阿里巴巴还发布了配套的Java开发规约IDE插件和代码规约扫描引擎,并出版了详解图书《码出高效》,通过各种渠道和形式帮助开发者学习和遵循开发规范。值得一提的是,手册中所获得的收入都捐赠给...
【Hive 开发规范】 Hive 是一个基于 Hadoop 的数据仓库工具,它允许通过类 SQL 的查询语言(HQL)来访问存储在 HDFS 上的大数据集。以下是一些常用的 Hive 开发规范: 1. **数据开发规范** - **Hive 数据目录...
《腾讯PHP开发规范v1.0》是一份由腾讯科技(深圳)有限公司制定的、针对PHP编程语言的开发规范文档,旨在提升代码质量和团队协作效率。这份规范详细规定了从项目结构、命名规则到错误处理等多个方面的编程标准,是...
# 前端开发规范手册 此手册主要实现的目标:**代码一致性**和**最佳实践**。通过代码风格的一致性,降低维护代码的成本以及改善多人协作的效率。同时遵守最佳实践,确保页面性能得到最佳优化和高效的代码。 此...
阿里开发规范插件,全称为P3C(Alibaba Java Coding Guidelines)插件,是阿里巴巴为提高代码质量和一致性而制定的一套编码规范。这个插件主要用于集成开发环境Eclipse,帮助开发者在编码过程中实时检查代码是否符合...
### 数据库设计开发规范知识点概览 #### 一、数据库设计开发规范概述 《数据库设计开发规范-阿里.pdf》是一份由阿里巴巴云数据库服务部门编制的技术文档,旨在为数据库设计和开发提供一套全面且规范化的指导原则。...
医保信息系统安全开发规范。本规范用于规范和统一医疗保障信息系统生命周期各阶段(包括:安全需求分析、系统安全设计、 系统开发安全、系统安全测试和系统部署上线等阶段)需执行的安全控制及安全任务,明确系统...
### C# Winform应用程序开发规范知识点详述 #### 一、引言 在现代软件开发领域,用户体验(User Experience, UX)变得越来越重要。对于基于Windows平台的应用程序来说,使用C#结合Winform进行开发是一种常见且高效...
在软件开发过程中,遵循一套统一的开发规范至关重要。这不仅有助于提高代码质量,减少错误,还能提高团队协作效率。本文将深入探讨“代码开发规范”和“团队开发规范”,主要针对C#和VB.NET编程语言,同时也会涉及...
### Web程序开发规范详解 #### 一、引言 在软件工程领域,开发规范的建立对于确保代码质量、提升团队协作效率以及维护系统的稳定性和可扩展性至关重要。本文基于一份详细的web程序开发规范文档,深入解析其中的...
Web 前端开发规范手册 摘要:本手册旨在提高团队协作效率、便于后台人员添加功能及前端后期优化维护,输出高质量的文档。本手册涵盖了文件规范、CSS 书写规范、html 书写规范、JavaScript 书写规范、图片规范、注释...
《阿里巴巴Java开发规范》是Java开发者的一份重要指南,它为编写高质量、可维护的代码提供了明确的标准和建议。这份规范不仅适用于阿里巴巴集团内部的开发团队,也对广大Java开发者有着广泛的参考价值。以下是该规范...
参考阿里巴巴开发规范整理