北大青鸟Java培训:如何规范自己的代码编辑方法？

今天，我们来看看标准化代码编写的要求。

希望通过阅读这篇文章，可以提高对代码规范的理解。

1.保证代码压缩后不会出错。对于大型JSP项目，当产品发布时，项目中包含的所有JSP文件通常都是压缩的。例如，可以使用GoogleClosureCompilerService压缩代码。jQuery的新版本使用了这个工具来压缩代码，它通常会删除开发过程中编写的注释，并删除所有空格和换行符。你甚至可以用一个短而无意义的变量名来代替原来的长变量名。这样做的目的是为了加快文件的下载速度，同时减少网站访问带来的额外数据流量。另外也起到了一点代码保护的作用，至少压缩后的代码即使还原后也不那么好读了。

为了让代码正确地通过压缩，通常要求语句应该以分号正常结束，大括号应该严格结束，等等。，取决于压缩工具的要求。

所以如果一开始不按标准做，压缩错误后再回去找错误，那就是浪费时间。

2.确保代码可以通过特定IDE的自动格式化功能。一般比较完善的开发工具(如AptanaStudio)都有代码“自动格式化”的功能，有助于实现换行符、缩进、空格等统一的代码排列。可以设置自己喜欢的格式标准，比如开大括号{是否另起一行？

实现这一要求的目的是为了方便开发团队成员获取代码的副本，并使用IDE自动将其格式化为他们喜欢或熟悉的样式。

你的同事需要看你的代码，可能是因为你写了一个通用的方法，他也需要用在其他模块的开发中。阅读你的代码可以深入了解方法调用和实现的细节，这是简单的API文档无法达到的效果。

3.使用标准文档注释的要求是基本的，有利于在方法调用处看到方法的具体参数。您还可以使用支持文档工具来生成html或其他格式的开发文档，供其他团队成员阅读。可以试试用jsdoc-toolkit。

如果你自动生成的API来自一个开放平台，就像facebook.com应用程序一样，那么你的文档是为全世界所有开发者准备的。

此外，编写完整的注释更便于团队成员阅读您的代码。通过你的参数描述，团队成员可以很容易地知道你写的方法的细节，并参与实现。

当然也方便以后的代码维护，这样即使是大项目，时间长了，回去改东西的时候也不会忘记当时写的东西。

4.使用标准化且有意义的变量名。使用标准化且有意义的变量名可以提高代码的可读性。作为大型项目开发的一员，自己写的代码不仅要让别人容易理解。

计算机培训/以为大型项目的开发，其实大家可能都写了大量的代码，规范的命名，后来回头看看自己的代码也是清晰易懂的，比如以后系统升级或者新增功能，修改代码就容易多了。

如果你现在发现自己连当初写的代码都看不懂，那就大错特错了。