java 代码书写规范_代码书写规范和命名规范

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

1、代码书写规范

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

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

java文件，通常可以分为这么几个部分：

a、申明包(package)

b、引入包(import)

c、类定义(class)

d、类属性

e、类方法

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

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

2、命名规范

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

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

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

注：

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

java 代码书写规范_代码书写规范和命名规范相关推荐

mysql 字段名称规范_数据库表及字段命名规范
数据库设计表及字段命名规范(我整理的,望大家多多提建议) 1.数据库表命名规范: (1)表名前应该加上前缀,表的前缀一个用系统或模块的英文名称缩写,前缀全部大写或首字母大写,表名中包含的单词首字母大写 ...
前端命名规范_值得收藏的前端命名规范
不知道大家有没有这样一个苦恼,在开发过程中经常为了起一个css名,文件名,组件名而苦恼起的高大上点害怕连自己都看不懂,起的太简单又显得自己很不专业下面我们就来解决这个问题布局使用语义化标签对于 ...
c++ doxygen 注释规范_[代码规范]Go语言编码规范指导
本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...
jsp文件命名规范_代码规范整理
我喜欢优雅和高效的代码.代码逻辑应当直截了当,叫缺陷难以隐藏:尽量减少依赖关系,使之便于维护:依据某种分层战略完善错误处理代码:性能调至最优,省的引诱别人做没规矩的优化,高出一对混乱来.整洁的代码只做 ...
java代码重构工具_代码重构什么意思 Java代码重构的几种模式
指对软件代码做任何更动以增加可读性或者简化结构而不影响输出结果. 软件重构需要借助工具完成,重构工具能够修改代码同时修改所有引用该代码的地方.在极限编程的方法学中,重构需要单元测试来支持. 在软件工程 ...
java 代码整洁快捷方式_代码整洁之道：你的代码是否足够优雅、整洁、易懂？...
普通的工程师堆砌代码,优秀的工程师优雅代码,卓越的工程师简化代码.如何写出优雅整洁易懂的代码是一门学问,也是软件工程实践里重要的一环.下面从注释.命名.方法,并发等视角简单给出了部分最佳实践.相信每一 ...
java 代码坏味道_代码中的坏味道
前言在日常生活中,当我们买的水果放久了之后会发出一种难闻的气味("坏味道"),这个时候我们就应该把它扔掉.同样,代码也有"坏味道",当然确定什么是和不是代码& ...
软件工程师职业道德规范_看一下三个职业道德规范的最新更新
软件工程师职业道德规范 It is common for professional societies and membership organizations to have a Code of E ...
python代码自动格式化_代码的自动格式化
代码格式化是一个在软件开发过程中值得一提的话题. 所谓代码格式化就是说,程序员在书写代码的过程中或者完成代码开发后对代码书写格式排版的调整,使得已经完成的代码变的更美观整洁也更具有可读性,也能增加完成 ...

java 代码书写规范_代码书写规范和命名规范

java 代码书写规范_代码书写规范和命名规范相关推荐

最新文章

热门文章