开发规范

1:制定API的时候,一定要考虑到参数类型、方法返回类型和所能抛出的异常,由于API改动的代价非常大,因此一定要考虑清楚,API要考虑后续的扩展,一个方法的内部实现是可以随意变化的,只要保证实现向后兼容就行,但暴露出来的API一般就不可能再去变了。

2:制定xml格式的时候,能用属性最好不要用text,因为属性用dtd/schema容易约束,而text则不好或不能约束。
群内tank给的例子:
<contact>
<name>张三</name>
<email>[email protected]</email>
</contract>

换成,方便程序读取
<contract>
<property name="name" value="张三" />
<property name="email" value="[email protected]" />
</contract>
或者,方便DTD/SCHEMA,读取的话也不是很麻烦
<contract name="张三" email="[email protected]" />

第一种格式最差,标签没规律,程序不方便统一读取;最后一种如果加一个attribute,那么必须要告知读取程序这个attribute的name;中间的方式,加一个attribute,则格式都是相同的。

用text还有一个坏处:
<name>张三</name>
<name>
   张三
</name>
后者,有的框架读出来是"张三",有的读出来是"\r\n张三\r\n"

多谢tank.

你可能感兴趣的:(开发)