上一篇给大家分享了一下，关于文档编写的几个概念。这篇文章阐述如果编写代码书写规范以及命名规范文档。【以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、命名规范

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

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

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

    注：

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

本文出自 “java程序冥” 博客，请务必保留此出处http://793404905.blog.51cto.com/6179428/1529833