编程的一些代码风格（JAVA）

柔光的暖阳◎ 2022-08-12 02:00 166阅读 0赞

**吐槽**：  
我这几天终于明白为什么说“一个软件产品的80%的生命期是在维护”。“金九银十”，这段时间师兄师姐们都去找工作了，研究所遗留系统的维护工作就交到了我的手上。

我一开始还是蛮高兴的，因为觉得又可以学点东西了，但是当我部署完看到代码的那一刹那，我想死的心都有了。

系统的包大部分是以人名命名，其中还掺杂着业务名，代码也写的“东倒西歪”。结果我改了几天，大致代码能看了，哎，都是泪。结合前几天看了一个公司的项目结构，发现分包分的也是不太好（dao层的东西全写在service里，并且model、action、service全在一个包下面），所以想着写篇博文，鞭笞自己以后一定要做到代码至少“能看”，毕竟良好的代码风格，提高了代码的可读性、持续性和易维护性，使后人能更容易的理解和维护。 废话不多说，结合实际说说我看重的几点代码风格吧。

**a.文件命名方式**  
英文命名：无论是包名还是文件名，都进来用英文简称、不然别人怎么理解。比如“zcgl”你能想到是“资产管理”相关的业务吗？  
驼峰：类里面定义的一些变量最好也用英文简称，并且使用骆驼式命名法，如userInfo,userLogin。  
  
**b.项目结构，分包**

一般来说，开发一个项目的时候这方面都是项目组长规定好的，但是平常也应该养成这个习惯，毕竟码奴也是可以梦想当架构师的嘛，哈哈~

现在都强调MVC，所以我一般分包这三层肯定是分开的，比如ssh项目，后台会分成action、dao、model、service（当然内部可能还有impl之类的包，这里就不细说）。

一些工具类则可以放在util包里面，全局调用的类也可以新建个包，比如exception,interceptor之类的。

前台的主要就是css,js,image,jsp之类的会分开

总的来说，好的分包可以帮助你更快的理解项目结构、查找文件等等，那你又何乐而不为呢？  
  
**c.注释**

这一点我不说相信大家也都应该能做到，但是我说下我的一些“洁癖”：

尽可能的使用Javadoc注释(在类和方法上，使之能最小化)；

多使用块注释/\*\*/，少使用//注释, 除非一些特殊的情况，如变量声明；

方法上面基本上肯定要有注释（这样在一些开发工具里面，不用打开文件就能看到这个方法的作用）。  
      
**d.代码美观**  
好吧，这里我有强迫症，我偏要把代码对齐、缩进、多余的空行和无用的引用包删掉。当然除了这些，有些代码如sql语句太长、html语句太长，则都是建议换行的。  
  
哎，不说了，吐槽结束！欢迎大家一起吐槽，嘿嘿~

发表评论取消回复

表情：

评论列表（有 0 条评论，166人围观）

还没有评论，来说两句吧...

相关阅读

相关代码规范疏忽导致的错误：Java编程风格不一致

Java编程风格一致性是编写高质量代码的重要部分。不一致的风格可能会导致以下几种类型的错误： 1. **阅读理解困难**：如果其他开发者看到你的代码，但由于风格差异而无法立即

我会带着你远行/ 2024年09月25日 23:57/ 0 赞/ 22 阅读

相关编程的一些代码风格（JAVA）

吐槽：我这几天终于明白为什么说“一个软件产品的80%的生命期是在维护”。“金九银十”，这段时间师兄师姐们都去找工作了，研究所遗留系统的维护工作就交到了我的手上。

柔光的暖阳◎/ 2022年08月12日 02:00/ 0 赞/ 167 阅读

相关 Google Java编程风格指南

转译出自 http://www.hawstein.com/posts/google-java-style.html 目录 1. [前言][Link 1] 2. [源

雨点打透心脏的1/2处/ 2022年08月10日 08:55/ 0 赞/ 167 阅读

相关 Google Java编程风格指南

[Google Java编程风格指南][Google Java] January 20, 2014 作者：Hawstein 出处： [http://hawstein

女爷i/ 2022年08月10日 05:47/ 0 赞/ 154 阅读

相关 Shell脚本编程的一些小风格

Shell虽然是脚本语言，但我们也不能忽略其优雅的编程风格，下面是一些小的书写习惯。将命令或命令组合设为一个见名知意的别名，在一个Shell环境中可以被多次调用，同时

深藏阁楼爱情的钟/ 2022年08月07日 04:40/ 0 赞/ 148 阅读

相关 Java编程风格

来自《The Elementsof Java Style》\-《Java编程风格》一书，值得一读的书籍，会让你在细节上节省很多时间，合作之间更加愉快！好处不多说了，但是有几

爱被打了一巴掌/ 2022年07月26日 01:52/ 0 赞/ 168 阅读

相关优秀Java程序员的编程风格

![0][] 今天突发奇想，对编码习惯和编程风格很感兴趣，于是乎，找了一下关于编程风格（Java篇）的资料，希望对爱好编码或者开始学习编码的同学有帮助！

╰+哭是因爲堅強的太久メ/ 2022年06月07日 02:36/ 0 赞/ 185 阅读

相关编程风格

一、了解一个懵逼的编程风格面向过程编程面向对象编程基于类的面向对象编程基于原型

雨点打透心脏的1/2处/ 2022年05月26日 08:17/ 0 赞/ 180 阅读

相关优秀Java程序员的编程风格

来自《The Elements of Java Style》-《Java编程风格》一书，值得一读的书籍，会让你在细节上节省很多时间，合作之间更加愉快！　　好处不多说了，但是

今天药忘吃喽~/ 2022年03月18日 02:44/ 0 赞/ 218 阅读

相关 JavaScript编程风格、代码规范

也写了挺长时间的js代码了，回过头来看看很多基础的问题都没有注意到，重新认真学习了一下代码规范，还是很有必要学习的，好的开始是成功的一半，如果连基本的规范都没有达到，那写出来的

清疚/ 2021年12月15日 01:41/ 0 赞/ 260 阅读