写代码需要注意的地方

以下属于个人总结,如有更好的方法或错误欢迎评论指出。

一、命名:一个好的命名让代码的可读性更强。(希望大家评论给出自己更好的命名方法,我再更新到这)

1)类名需要尽可能的简约(不超过三个业务描述的单词,超过了可以缩写某个单词或直接省略);例如 用户控制类 UserController,用户日志控制类 UserLogController,登录用户新增日志控制类 LoginAddLogController(这里省略了用户单词)

2)方法名可以描述更具体特别是带查询条件方法;例如 通过名称,班级id查询用户集合,可以selectUserByClassIdAndUserName

假如你写成selectUser,如果还有一个查询用户的方法那么就不好区分了。

3)数据库命名同样需要简约 需要注意的是数据库不区分大小写,用下划线隔开关键字;且单词较长的关键字需要缩写。还有就是一些功能模块划分的前缀。例如:系统 用sys前缀 sys_user,配置 用base前缀 base_city,购物模块可以 buy_cart 购物车表 。如果业务描述较复杂也可以省略某个单词。

4)变量命名这个要求不是很严格,但总体来说也是需要简约的。个人建议:传入参数添加一个前缀 例如:inUserId,返回参数添加一个result单词 例如 resultUserList,其他变量基本上是对象类的缩写添加一些描述单词。例如queryUser。

二、代码格式  我发现很多新手写代码喜欢一个方法写很多的业务逻辑。这样可读性极差,代码的可复用性也差,且不易维护。我们写代码尽可能的是把一件事情分隔为一个方法。一个方法超过100行我觉得就应该分子方法出来了。如果一开始你不能够分离开这些方法,但是你可以等写完之后再进行分离。标注出 第一步:xxxx;第二步:xxxx 这样代码层次清晰了,逻辑清晰了无形中可以避免一些奇怪的不易察觉的bug。我给一些新手查过奇怪的bug大多是因为代码写的可读性差导致很难自己发现bug。

三、写代码思路  其实对于老程序员来说写代码都不叫一个事噼噼啪啪就写了给七七八八。那么新手应该怎样构思自己的代码呢?

首先我们需要了解需求,知道我们要实现一个什么样的功能,怎么去实现,逻辑是怎样的,全部了解清楚了再动手。不要领到任务了就因为时间赶就直接开写,不清楚的地方到时候再说。一定要全部清楚了再写,如果逻辑复制可以在纸上自己先写一下捋顺了再开始写代码。

四、工具的应用  对应现在的程序员来说是幸福的,因为我们有大量的工具可以用。如果一些费时的事情,不妨先百度 Google一下有没有辅助工具能够帮你,或者自己写一个脚本,程序工具。磨刀不误砍柴工,一个好用的工具能够节省你很多时间。早早就下班它不香吗?

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章