代码格式

lz最近在看之前同事留下来的代码,还是有些头大的,个人还是蛮尊敬这位同事的,这块代码是他刚入职的时候写的,(ps:lz也是刚刚入职的小菜鸟)他也嫌代码写的不好,自己看起来也头大,哈哈哈
这边想个人对自己写代码提一些要求,跟大家共勉,也希望大家能有好的建议给lz

. 注释
个人感觉注释真的太重要了,没有注释看代码真的有些云里雾里,当然了,注释也要写的好,个人比较多的使用到了文档注释/* * */,而且推荐在属性上使用,这样看变量的时候更加简单明了,在方法的注释上,对于@的文档注释,也要熟练运用

 @author   对类的说明 标明开发该类模块的作者

@version   对类的说明 标明该类模块的版本

@see     对类、属性、方法的说明 参考转向,也就是相关主题

@param    对方法的说明 对方法中某参数的说明

@return   对方法的说明 对方法返回值的说明

@exception  对方法的说明 对方法可能抛出的异常进行说明
//....

. 变量,方法等的取名
方法的取名一定要是这个方法实现的功能的概括,这样更加便于代码的阅读,在即使没有注释的情况下,而且更加一目了然,而变量的命名也要切合该变量所要表达的意思,切勿使用拼音啊各位亲们..个人感觉在bean类的取名上,尽量保持一致性,比如lz写的:
这里写图片描述
是不是看起来舒服很多,哈哈哈有强迫症啊你!

. 代码的封装

. 接口的设计
这个后续补充吧哈哈哈,我也不会,大概就是取名取得易懂一点吧

. 枚举类的使用
感觉枚举是很重要的,我们CTO讲代码不能出现那些0啊1啊的东西,因为不易懂,时间久了连自己都不知道当初写了什么为什么这么些,所以我自己琢磨着就是这么些

//比如,0表示某个消息取到
sendMessage(request,0);
写成
/**阿里大于*/
int SEND_TYPE = 0;
sendMEssage(request,SEND_TYPE);
这样子就清晰很多

先写到这里吧,后续lz有心得的时候在补充…

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值