基本代码编码规则《一》

本文详细介绍了软件开发中包、类、方法及变量的命名规范,包括驼峰命名法、分层命名策略及方法命名前缀约定。同时,阐述了参数使用、页面命名、代码注释、编码风格、异常处理等最佳实践。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、包/类/方法/变量命名规范
    包名:英文,小写,能明确表示业务。【如:prodoperate】
     类名:英文,每个单词首字母大写,明确代表含义(表+层)
    【如:ProdInfo, ProdInfoDao, ProdInfoManager,ProdInfoAction,ProdDictVo】
     方法,变量名:统一采用驼峰命名法(如findByUserName)
    项目各个层之间的命名方法,一般项目主要是以增删改查为基础。
    增加以add开头,删除以del开头,修改以update开头,查询以find/get开头,统计以count开头。
    
2、方法的参数

    参数在4个及以上的方法,并且是非对象类型的参数,都用Map<String,String>
    不分页查询方法参数类型:Map<String,String>,可看下面案例图
    分页查询方法参数类型:Page<T>, Map<String,String>


3、类/方法的案例(方法名字和一致,比如html名字是accountsAdd.html,则对应AccountsAction类的方法add)

    要求自定义vo类,以辅助封装多个表关联查询的结果集,方便页面显示
    新增方法(add*)
    新增方法名称以add开头【如:addUser】
    保存方法(save*)
    保存方法名称以save开头【如:saveUserName】
    修改方法(update*)
    修改方法名称以update开头【如:updateUserStatusById】
    查询方法(find*)
    查询方法名称以find*开头【如:findByUserName】
    删除方法(delete*)
    删除方法名称以delete*开头【如:deleteById】

    查询方法名称以get*开头【如:getProPage】(带分页Page)
    查询方法名称以get*开头【如:getProAll】(不带分页ALL)    

4、页面
    页面遵循实体+CRUD,例如:
    accountsList.jsp/Html
    accountsAdd.jsp
    accountsEdit.jsp
    accountsView.jsp

5、代码注释模板
    
      在myeclipse里面的:
    window->preference->java->code style->cod templates->comments->types

6、编码风格
    
       if,for,while,switch等结构中的总是用"{"和"}"括起来。

    不建议情况一:不明确执块
     if (true) 
          statement;

    不建议情况二:存在空块
    if (true) {
     …code.
    }else{
     //此处里面没代码
    }

7、异常处理


8、不允许有硬代码

    无BUG

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值