编码规范、Git分支整理

这篇具有很好参考价值的文章主要介绍了编码规范、Git分支整理。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

代码命名规范

包命名规范

采用反域名命名规则,全部使用小写字母。一级包名为com,二级包名kl(为公司名称,可以简写),三级包名pos(根据应用进行命名),四级包名activity或adapter等(模块名或层级名),根据实际情况也是可以用五级包名,六级包名。例如:com.kl.pos.activity | com.kl.pos.adapter

特殊项目命名规范

可以在已有规范基础上,添加固定项目前缀,如kl项目,Activity可改为KlLoginActivity,Layout布局为kl_activity_login。以防止引用此特殊项目,查找文件时候同名文件多,修改维护成本大。

Class文件命名方式

Activity 命名一律使用 模块名+Activity 的方式。例如: LoginActivity、UserActivity。
Fragment 命名一律使用 模块名+Fragment 的方式。例如: HomeFragment 、 WeatherFragment。
自定义View 功能名+View/ViewGroup(具体的组件名称)。例如:WhiteLayout、RatingView.
Widget组件 功能名+Widget。 例如:ScanWidget、WeatherWidget。
Dialog对话框 功能名+Dialog。例如:LoginDialog、ProgressDialog。
Adapter 命名一律使用 模块名+Fragment 的方式。例如: HomeAdapter、 WeatherAdapter.

Layout命名

Activity activity_模块名。例如 R.layout.activity_login
Fragment fragment_模块名。例如 R.layout.fragment_login_layout_header
Include layout_模块名_功能名。例如 @layout/layout_login_bottom
Adapter item_模块名_功能名。例如 R.layout.item_simple_text
Dialog dialog_模块_功能名。例如 R.layout.dialog_time_picker

Values资源文件命名

color color_模块名。例如 color_material_design
dimens dimens_模块名。例如 dimens_material_design
style style_模块名。例如 style_material_design
themes themes_模块名。例如 themes_material_design
strings strings_模块名。 例如 strings_meatrial_design 其他模块以此类推

接口命名规范

命名规则与类一样采用大驼峰命名法,多以大写的I(interface缩写)开头或者able或ible结尾,如interface Runnable ;interface Accessible 。或者参照类似 Android接口。如点击事件 OnClickListener等。

变量命名

成员变量采用小驼峰命名法 userName deviceName。

常量命名

字母全部大写,单词之间用下划线_隔开。关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是 说,程序中除0,1以外,尽量不应该出现其他数字,如果0和1能够被取代,也是不允许出现的。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

 

分支命名规则

  1. 分支前缀-版本号-功能

  2. 分支前缀必带,master、develop分支无需携带版本号,主release分支无需携带功能信息

分支前缀规则

分支

描述

是否是保护分支

master

主分支

develop

主开发分支

release

发布分支

feature

功能分支

hotfix

bug修改分支

chore

增加构建、自动化、脚本化配置分支

分支关系流程图

分支操作流程

新功能

  1. 从develop分支切出,命名为 feature-版本号-功能

  2. KL项目代码提交必须携带任务号或者bug号

  3. 功能开发完毕交付测试人员进行测试

  4. 测试通过merge入develop分支,勾选删除原分支

功能bug修复

  1. 从develop分支切出,命名为 hotfix-版本号-功能

  2. KL项目代码提交必须携带任务号或者bug号

  3. bug修复完成交付测试人员进行测试

  4. 测试通过merge入develop分支,勾选删除原分支

版本发分支准备

  1. 从develop分支切出,命名为 release-版本号-功能
    alpha版本:命名为release-版本号-alpha 比如:release/2.2.0-alpha
    beta版本:命名为release-版本号-beta 比如:release/2.2.0-beta
    正式上线版本:命名为release-版本号 比如:release/2.2.0

  2. 修改版本号、切服等基础步骤后,提交代码并附加任务号

  3. 在发版之前,合并到master分支并打tag

  4. 走版本发布流程

分支删除规则

  1. 合并到develop后的分支要及时删除

  2. 主release分支不可以删除

  3. 如果当前分支要延后到指定版本上线,要及时修改分支版本号,对于过期的版本及时清理文章来源地址https://www.toymoban.com/news/detail-484606.html

到了这里,关于编码规范、Git分支整理的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 写代码时候的命名规则、命名规范、命名常用词汇

    版权声明 这个大部分笔记是观看up主 红桃A士 的视频记录下来的,因为本人在学习的过程中也经常出现类似的问题,并且觉得Up主的视频讲解很好,做此笔记反复学习,若有侵权请联系删除,此推荐视频地址:【改善丑陋的代码】 https://www.bilibili.com/video/BV1844y1N7S8/p=28share_sou

    2024年02月10日
    浏览(49)
  • Git —— 分支重命名操作

    在开发中,对某个分支进行重命名的操作: 1、本地分支重命名 本地分支是指:你当前这个分支还没有推送到远程的情况,这种情况修改分支名称就要方便很多 2、远程分支重命名 1.先重命名本地分支 2.删除远程分支 3.上传新修改名称的本地分支 4.修改后的本地分支关联远程

    2024年02月11日
    浏览(37)
  • Git 分支重命名

    Git 是目前最流行的版本控制系统之一,而分支是 Git 的核心特性之一。在开发过程中,我们经常需要对分支进行重命名,以更好地组织和管理代码库。本篇博客将介绍如何使用 Git 命令进行分支重命名操作。 步骤: 确定当前分支:首先,在进行分支重命名之前,我们需要确定

    2024年02月14日
    浏览(33)
  • 代码命名规范的套路是真优雅呀,命名如歌,代码如诗

    日常编码中,代码的命名是个大的学问。能快速的看懂开源软件的代码结构和意图,也是一项必备的能力。那它们有什么规律呢? Java项目的代码结构,能够体现它的设计理念。Java采用长命名的方式来规范类的命名,能够自己表达它的主要意图。配合高级的IDE,可以减少编码

    2024年02月04日
    浏览(46)
  • Git 分支管理及规范

    1. 分支管理 代码提交在应该提交的分支 随时可以切换到线上稳定版本代码 多个版本的开发工作同时进行 2. 提交记录的可读性 准确的提交描述,具备可检索性 合理的提交范围,避免一个功能就一笔提交 分支间的合并保有提交历史,且合并后结果清晰明了 避免出现过多的分

    2024年02月15日
    浏览(39)
  • git~分支管理规范

    避免新开发的代码影响提测的代码 避免生产环境出现问题后,修复后,由于代码混乱,无法合并到生产环境 解决多个需求并行开发,并行测试,合并上线的问题 流程图工具我使用的是:diagrams.net 具体执行步骤 开发人员按需求粒度从dev建立分支 哪个需求或者哪些需求提测,

    2024年02月02日
    浏览(44)
  • 代码命名规范是真优雅呀!代码如诗

    日常编码中,代码的命名是个大的学问。能快速的看懂开源软件的代码结构和意图,也是一项必备的能力。那它们有什么规律呢? Java项目的代码结构,能够体现它的设计理念。Java采用长命名的方式来规范类的命名,能够自己表达它的主要意图。配合高级的IDE,可以减少编码

    2024年02月02日
    浏览(40)
  • Git重命名远程分支名称并关联本地

    注意: 当前分支名(本地) 与 远程分支名完全一致下!!! 注意: 当前分支名(本地) 与 远程分支名完全一致下!!! 注意: 当前分支名(本地) 与 远程分支名完全一致下!!! 假设本地与远程分支名都为A,现更换成B,操作如下: 第一步: 第二步: 第三步: 第四步:

    2024年02月11日
    浏览(69)
  • Git 的标准提交规范(Conventional Commits)& Git 分支管理

    其中,type 表示本次提交的类型,应该从以下几个类型中选择: feat:新功能 fix:修复问题 docs:文档更新 style:代码风格更新 refactor:重构代码 test:增加测试用例 chore:修改项目配置 [optional scope] 表示本次提交的影响范围,可以根据需要添加。 表示本次提交的描述信息,应

    2024年02月09日
    浏览(59)
  • 【C++】【命名规范】你的代码风格是哪种?(驼峰命名法、下划线命名法、帕斯卡命名法、常量命名法等)

            在 C/C++ 中,类名、接口名、变量名和函数名等的命名规则是比较自由的,开发者可以根据自己的喜好选择合适的命名方式。但是,为了保持代码的可读性和可维护性,我们通常遵守一些命名规则。         例如驼峰命名法、下划线命名法、帕斯卡命名法、常量

    2024年02月07日
    浏览(46)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包