如何明确程序开发规范

hengzhi
hengzhi 这家伙很懒,还没有设置简介...

0 人点赞了该文章 · 37 浏览

如何明确程序开发规范

    现在市场的逐步开放,造成了一个谁都可以进行程序开发工作的形式。这样就会造成杂七杂八的程序都会被流入到市场上,不仅会破坏市场原有的干净的环境,也会造成一些合法的程序遭到排挤的可能。所以,在这样一个大环境下,拥有一份优秀的程序开发明细表,是有多么的重要了。那很多人也许对此不熟悉,也不得知晓,那我就来讲一下。


    1. 总体要求 

    1、必须严格执行本规范以确保源代码的可读性及可维护性。 

    2、所有的程序文件都必须有注释文字,并严格按照本规范中的“注释规范”

    书写。 

    程序开发命名规范: 概述 

    1、 务必做到结构清晰,逻辑清楚 2、 工程相关文件清楚、明确、分类合理  3、 尽量使用常用标准英文单词,特殊地方使用中文拼音。 4、 如果有名词,必须使用单数形式。 5、 使用大小写混合格式,将连接的几个单词首字母大写。 6、 如果使用缩写,尽量使用常用缩写样式。 7、 以做到能别人能够轻松读懂,自己一年后可以轻松读懂为最高标准。 8、 所有文件命名均采用26个英文字母(区分大小写)和0-9这十个自然数,加上下划线_组成,共63个字符。不能出现其他字符(注释除外) 9、 系统采用Pascal大小混写模式命名。特殊说明除外。

    程序开发 文件夹命名 

    文件夹命名一般采用英文,长度一般不超过20个字符,使用大小写混合格式,
将连接的几个单词首字母大写。除特殊情况才使用中文拼音,一些常见的文件夹命名如:Images,Javacripts(存放Javascript脚本),,Media(存放1、类。 

    类名使用camel大小写形式. 

    对于页面中使用的类,通常情况下与前台页面的文件名是一致的,比如,对于一个页面frmHelloWorld.aspx, 该类放置于APP_CODE文件下,其类名会如下定义: 
public class frmHelloWorld  {  „ } 

    对于作为类库的类,则应按照约定加一定的前缀,根据不同的类的类型添加不同的前缀,表明为类库使用类。 该类放置于App_Code或类库项目中比如一个通用类可以如下定义: public class clsHelloWorld参数名应该具有足够的描述性,这样在大多数情况下参数名和它的种类可以用来确定它的意思。

    根据程序开发参数的意思来命名参数,而不是根据参数的种类来命名。我们希望开发工具可以用很方便的方式提供关于参数种类的信息,这样参数名可以得到更好的使用,可以对语义而不是对种类进行描述。但是偶尔使用根据类型命名的参数名也是完全可以的。不要使用保留参数。如果在下一个版本中需要更多的数据,可以增加进来。

   

发布于 2022-09-28 22:49

免责声明:

本文由 hengzhi 原创或收集发布于 火鲤鱼 ,著作权归作者所有,如有侵权可联系本站删除。

火鲤鱼 © 2026 专注小微企业服务 冀ICP备09002609号-8