一、注释

首先，我们先谈一下注释。

什么是注释？注释就是说明解释性的文字 。

而代码注释是架起程序设计者与程序阅读者之间的通信桥梁，可以最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。

那么，怎么写注释比较好呢？有以下几点需要大家注意：

1、注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。

2、注释内容准确简洁

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

当内容很显而易见的时候，进行重复的注释是很没有效率的。

如果你必须对该代码进行注释，那你可以简单地将其合并到一行中。

简单的代码做简单注释，注释内容不用写的太多。

注释条件：

A、基本注释（必须加）

a) 类（接口）的注释。b) 构造函数的注释。c) 方法的注释。d) 全局变量的注释。e) 字段/属性的注释。

B、特殊必加注释（必须加）

a) 典型算法必须有注释。b) 在代码不明晰处必须有注释。c) 在代码修改处加上修改标识的注释。d) 在循环和逻辑分支组成的代码中加注释。e) 为他人提供的接口必须加详细注释。

关键性的语句需要加注释，例如特定的变量含义解释，特别的条件或者函数意思解释。

特定的变量含义解释，特别的条件或者函数意思解释没有统一的标准，自己来恒定，不同阶段所理解的关键性都有区别。

二、一致的缩进

常用的 IDE 都有代码格式化。大家写完程序，删去无用空行，Ctrl + Alt + L调整一下就可以了。

那么在这里需要注意的是使用 Tab 缩进就不能使用空格缩进，不可以混用。

三、代码分组

通常情况下，某些任务需要几行代码，那么使用空行将这些代码分隔开是一个不错的主意。

这会让它们之间有一些空间。

然后再在每个代码块的开头添加注释，视觉上看起来就是分离的代码块了。

比如说：new 了几个对象，然后要使用这些对象的方法，那么，在这之间，我们可以来上一个空行。

       

四、一致的命名方案

这个上次提到过，那么这次再和大家分享一下。

首先，命名应该有单词边界。我们现在最常用的就是驼峰法。

camelCase(骆驼命名法)：除了第一个单词，每个单词的第一个字母都大写。

命名方法很多，类似于前面提到的缩进方式，命名方法也有不同的选择。一些语言倾向于使用一种命名方案。例如，在 Java 中，大多数代码都使用 camelCase 方式来命名。

五、避免嵌套太深

嵌套过多会使代码更难读取和跟踪。

这个没有办法具体的讲，只能说，平时写代码的时候多注意。

尽可能减少的 if for 循环嵌套层数与尽量少使用递归。

六、限制行的长度

眼睛在阅读高而窄的文本时会更舒服，这正是报纸文章总是二三十字为一行的原因。

我们在编写代码时，尽量不要将一行代码写出屏幕外。

虽然这种情况比较少，但是我们还是需要时刻注意。

七、文件和文件夹结构尽可能将文件整理归类，方便日后查找：

没有什么最佳的代码格式，只有统一得代码格式。

一、注释

首先，我们先谈一下注释。

什么是注释？注释就是说明解释性的文字 。

而代码注释是架起程序设计者与程序阅读者之间的通信桥梁，可以最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。

那么，怎么写注释比较好呢？有以下几点需要大家注意：

1、注释形式统一

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。

2、注释内容准确简洁

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

当内容很显而易见的时候，进行重复的注释是很没有效率的。

如果你必须对该代码进行注释，那你可以简单地将其合并到一行中。

简单的代码做简单注释，注释内容不用写的太多。

注释条件：

A、基本注释（必须加）

a) 类（接口）的注释。b) 构造函数的注释。c) 方法的注释。d) 全局变量的注释。e) 字段/属性的注释。

B、特殊必加注释（必须加）

a) 典型算法必须有注释。b) 在代码不明晰处必须有注释。c) 在代码修改处加上修改标识的注释。d) 在循环和逻辑分支组成的代码中加注释。e) 为他人提供的接口必须加详细注释。

关键性的语句需要加注释，例如特定的变量含义解释，特别的条件或者函数意思解释。

特定的变量含义解释，特别的条件或者函数意思解释没有统一的标准，自己来恒定，不同阶段所理解的关键性都有区别。

二、一致的缩进

常用的 IDE 都有代码格式化。大家写完程序，删去无用空行，Ctrl + Alt + L调整一下就可以了。

那么在这里需要注意的是使用 Tab 缩进就不能使用空格缩进，不可以混用。

三、代码分组

通常情况下，某些任务需要几行代码，那么使用空行将这些代码分隔开是一个不错的主意。

这会让它们之间有一些空间。

然后再在每个代码块的开头添加注释，视觉上看起来就是分离的代码块了。

比如说：new 了几个对象，然后要使用这些对象的方法，那么，在这之间，我们可以来上一个空行。

       

四、一致的命名方案

这个上次提到过，那么这次再和大家分享一下。

首先，命名应该有单词边界。我们现在最常用的就是驼峰法。

camelCase(骆驼命名法)：除了第一个单词，每个单词的第一个字母都大写。

命名方法很多，类似于前面提到的缩进方式，命名方法也有不同的选择。一些语言倾向于使用一种命名方案。例如，在 Java 中，大多数代码都使用 camelCase 方式来命名。

五、避免嵌套太深

嵌套过多会使代码更难读取和跟踪。

这个没有办法具体的讲，只能说，平时写代码的时候多注意。

尽可能减少的 if for 循环嵌套层数与尽量少使用递归。

六、限制行的长度

眼睛在阅读高而窄的文本时会更舒服，这正是报纸文章总是二三十字为一行的原因。

我们在编写代码时，尽量不要将一行代码写出屏幕外。

虽然这种情况比较少，但是我们还是需要时刻注意。

七、文件和文件夹结构尽可能将文件整理归类，方便日后查找：

没有什么最佳的代码格式，只有统一得代码格式。