代码书写规范和命名规范

上一篇给大家分享了一下,关于文档编写的几个概念。这篇文章阐述如果编写代码书写规范以及命名规范文档。【以java语言为例】

1、代码书写规范

代码书写规范,能够让不同的人,写出相同风格的代码。很多人都看过java源代码,你会发现java源代码的整体风格几乎是一致的,但是你要知道编写源代码的人是很多的,如何才能让他们写出同一风格的代码呢?这就是代码书写规范的作用。

代码书写规范描述的是如何从头到尾书写代码(自己定义的)。通俗点讲就是如何书写java文件。就像你写毕业论文一样,从头到尾每个细节都是有要求的,诸如格式要求,符号要求等等。所以你会发现一个学校里的人写出来的毕业论文,大体格式都是一样的。其实代码书写规范也就是这么一回事。

java文件,通常可以分为这么几个部分:

a、申明包(package)

b、引入包(import)

c、类定义(class)

d、类属性

e、类方法

基本上就是上述这些大块,现在我给这些大块定义一个格式:

<package部分>

<空一行>

<import部分>

<空一行>

<注释>

<类定义class>

<private属性>

<privagte静态属性>

<默认属性>

<protected属性>

<protected静态属性>

<public 属性>

<public 静态属性>

<类启动块>

<static启动块>

<无参构造方法>

<.........>

就如同上述这种方式,每一个位置,都有严格的格式定义,如果不同的开发人员都按照这样的方式书写,那么写出来的代码不就是同一个风格吗?这就是代码书写规范的用处。

2、命名规范

有了代码书写规范的格式要求,那么对变量等命名的同一,就是命名规范的作用了。往往命名规范要比代码书写规范要求更加直接一点,而且应该是开发中必须的,以前在开发中,就受尽了这种因为命名不统一而带来的痛楚。

往往不同语言的常用命名规则不同,市面上也有很多标准命名规范。我认为其实没有谁好谁坏,只要大家都统一使用某一种命名规范,这就可以了!

命名规范,就是教你如何去命名一个标识(变量名、类名、方法名、包名等等)。具体如何命名,这里不做详述,您可以参考文章的附件。

注:

附件是代码书写规范和命名规范,供有兴趣的人参考。有好的建议,大家一起交流!

代码书写规范和命名规范,布布扣,bubuko.com

时间: 2024-10-19 06:42:00

代码书写规范和命名规范的相关文章

代码编写与文件命名规范

文件命名规范 所有文件名均使用*小写字母*.文件名中不能包含_.所有类的文件名以.class.php结尾.类名和文件名的对应关系是 目录_目录_文件名 的形式. 例如Model_MySQLi_Abstract对应的就是model/mysqli/abstract.class.. 缩进规则与行书写规范 所有代码中,均使用4个空格作为缩进标准,不允许使用制表符(tab). 这样做的好处是:不管什么系统或者编辑器下看,代码都是整齐的.在使用SVN.CVS等工具或者查看diff时,不会对编码和阅读人员带来

PHP中的书写规则与命名规范

一.书写规则 1. 缩进 一个Tab. 2. 大括号{} 两种书写规则都可以,根据个人习惯. 3. 小括号与关键字之间有一个空格,小括号与函数紧贴 4. 运算符与变量(或表达式)两边有一个空格(字符串运算会除外) 二.命名规范 1. 类名 大驼峰 2. 类属性 m后跟大驼峰 3. 方法名 动词,大驼峰 4. 方法中的参数 小驼峰 5. 变量名与函数名 小写单词+下划线 6. 全局变量 g+大驼峰 7. 常量 全部字母都大写 8. 静态变量 s+大驼峰 以上命名规则可以组合使用. PHP中的书写规

C#中的代码书写规范以及命名规范

C#代码书写规则: 1. 尽量使用接口,然后使用类实现接口,以提高程序的灵活性. 2.一行不要超过80个字符 3.尽量不要手动更改计算机生成的代码 4.关键的语句写注释 5.建议局部变量在最接近使用它的地方声明 6.不要使用goto系列语句,除非使用在跳出深层循环时 7.避免出现使用超过5个参数的方法. 8.避免书写代码量过大的try....catch模块 9.避免同一个文件中放置多个类 10.生成和构建一个长的字符串时,一定要使用StringBuilder类型,而不用string类型 11.s

零基础如何学好python?Python代码规范之命名规范

目录 1.模块 模块尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况) 1 ''' 2 在学习过程中有什么不懂得可以加我的 3 python学习交流扣扣qun,934109170 4 群里有不错的学习教程.开发工具与电子书籍. 5 与你分享python企业当下人才需求及怎么从零基础学习好python,和学习什么内容. 6 ''' 7 # 正确的模块名 8 import decoder 9 import html_parser 10 11 # 不推荐的模块名 12

Swift— Swift编码规范之命名规范-备

程序代码中到处都是自己定义的名字,取一个有样并且符合规范的名字非常重要. 命名方法很多,但是比较有名的,广泛接受命名法有: 匈牙利命名,一般只是命名变量,原则是:变量名=类型前缀+描述,如bFoo表示布尔类型变量,pFoo表示指针类型变量.匈牙利命名还是有一定争议的,在Swift编码规范中几本不采用匈牙利命名. 驼峰命名(Camel-Case),又称骆驼命名法,是指混合使用大小写字母来名字.驼峰命名又分为:小驼峰法和大驼峰法. 小驼峰法是第一个单词是全部小写,后面的单词首字母大写,如:myRoo

修炼成高薪Java程序猿——从优秀的Java命名规范开始

优秀的Java命名规范 1命名规范 1.1 package (*) 包名全部由小写的ASCII字母组成,用"."分隔. 在此项目中,所有的包均以"com.prosten.ticket"开头. 1.2 class (*) 类名应当是名词,每个内部单词的头一个字母大写.应当使你的类名简单和具有说明性.用完整的英语单词或约定俗成的简写命名类名. [示例]public class UserManager 1.3 interface(*) 接口名应当是名词,每个内部单词的头一

前端CSS命名规范大全

文章整理了Web前端开发中的各种CSS规范,包括文件规范.注释规范.命名规范.书写规范.测试规范等. 一.文件规范 1.文件均归档至约定的目录中. 具体要求通过豆瓣的CSS规范进行讲解: 所有的CSS分为两大类:通用类和业务类.通用的CSS文件,放在如下目录中: 基本样式库 /css/core 通用UI元素样式库 /css/lib JS组件相关样式库 /css/ui 业务类的CSS是指和具体产品相关的文件,放在如下目录中: 读书 /css/book/ 电影 /css/movie/ 音乐 /css

PHP 代码规范、流程规范、git规范

代码规范.git规范.teambition规范.yii规范 1. 命名规范 (1).变量命名规范 1.变量使用驼峰命名法 禁止使用拼音或者拼音加数字 2.变量也应具有描述性,杜绝一切拼音.或拼音英文混杂的命名方式 3.变量包数字.字母和下划线字符,不允许使用其他字符,变量命名最好使用项目 中有据可查的英文缩写方式, 尽可以要使用一目了然容易理解的形式: 4.变量以字母开头,如果变量包多个单词,首字母小写,当包多个单词时,后面 的每个单词的首字母大写. 例如 :$itSports 5.变量使用有效

说说变量命名规范的重要性

在编程过程中一定要注意代码命名的规范性,否则在使用和维护过程中将造成很大的麻烦,这也是一种良好的编码习惯. 看下面代码,除了userPass命名规范[小驼峰命名法],其他的都不规范. uId:看get方法,就会发现是getuId(),因为java生成get方法时,先看变量的前两个字母,如果第二个字母不是大写,则第一个大写. UserMoney:看set方法,UserMoney=userMoney,没有了this. username:往往第二个单词首字母需要大写.