[技术规.docxVIP

前言 适用范围 本规范自发布之日起执行，范围涵盖熙菱信息技术有限公司软件工程事业部所有在建的软件项目和研发中的软件产品。 文档约定 我们通过“要”、“考虑”、“避免”和“不要”四个词来区分本文中不同规范的级别 要：描述的是必须遵循的规范。违反该级别的规范而又具有正当理由的情况是极其罕见的； 考虑：描述的是在一般情况下应该遵循的规范，但如果完全理解规范背后的道理，并有很好的理由不遵循它时，也不要畏惧打破常规； 不要：描述的是一些几乎绝不应该违反的规范； 避免：描述的做法通常不好，但却存在一些已知的可以违反该规范的情况。 总体上说，“要”和“不要”具有强制性质，而“考虑”和“避免”则是一些建议。 标识符命名规范 对标识符的命名要使用英文单词，必要时可以使用汉语拼音的全拼，严禁使用简拼来为任何标识符命名。 命名风格概述 我们主要使用PascalCasing、camelCasing和SCREAMING_CAPS三种标识符的命名风格，涵盖java、javascript、sql等编程语言。html/dhtml、xml/xsd/xslt、css等另行描述。下面分别描述这三种风格： PascalCasing风格 描述：把标识符中的每个单词的首字母(包括长度为2个字符以上的首字母缩写词)大写。两个字母长的首字母缩写词是一个特例，在这种情况下两个字母都要大写。 示例： PropertyDescriptor HtmlTag IOStream camelCasing风格 描述：把标识符中除了第一个单词之外的所有单词的首字母大写。 示例： propertyDescriptor htmlTag ioStream SCREAMING_CAPS风格 描述：标识符中所有字母均大写，单词之间用下划线分隔。 示例： PROPERTY_DESCRIPTOR HTML_TAG IO_STREAM 关于首字母缩写词和单词缩写 避免在标识符中使用首字母缩写词，除非他们是被普遍使用的，例如HTML、XML、IO等。 不要在标识符中使用单词缩写。注意单词缩写与首字母缩写词是完全不同的，如XML是一个首字母缩写词，表示Extensible Markup Language。而单词缩写仅仅是把一个单词变短，如Number到num。 正确：public Window getWindow(); 错误：public Window getWin(); public Window getWnd(); Id和Ok是两个比较特殊的缩写词，可以在标识符中使用。 在PascalCasing风格中，两个字母的首字母缩写词应该全部大写，如IOStream，超过两个字母的首字母缩写词只大写首字母，如HtmlTag。 关于复合词 不要把复合词中的每个单词的首字母大写 下表是一些常见的复合词和技术术语的拼写 PascalCasing风格拼写 camelCasing风格拼写 错误的拼写 BitFlag bitFlag Bitflag Callback callback CallBack Canceled canceled Cancelled DoNot doNot Dont Email email EMail Endpoint endpoint EndPoint FileName fileName Filename Gridline gridline GridLine Hashtable hashtable HashTable Id id ID Indexes indexes Indices LogOff logOff LogOut logOn logOn LogIn Metadata metadata MetaData,metadata Multipanel multipanel MultiPanel Multiview multiview MultiView Namespace namespace NameSpace Ok ok OK Pi pi PI Placeholder placeholder PlaceHolder SignIn singIn SignOn SignOut singOut SignOff UserName userName Username WhiteSpace whiteSpace Whitespace Writable writable Writeable java命名规范 包 要给java中的包赋予全小写字母的名字，哪怕是两个单词也不要用任何形式的分隔。为了遵循这一标准，请在为包命名时尽量用一个单词描述包 正确：java.usergroup 错误：java.userGroup 系统中的包路径设计要遵循如下规范： 第一级为固化的行业、产品线或者公司名，如数据管理产品