首页 > 其他分享 >代码提交规范——注释该如何写?

代码提交规范——注释该如何写?

时间:2023-07-12 15:55:48浏览次数:36  
标签:重构 代码 规范 注释 修改 提交

分类写:

commit 的类型:

  • feat: 新功能、新特性
  • fix: 修改 bug
  • perf: 更改代码,以提高性能(在不影响代码内部行为的前提下,对程序性能进行优化)
  • refactor: 代码重构(重构,在不影响代码内部行为、功能下的代码修改)
  • docs: 文档修改
  • style: 代码格式修改, 注意不是 css 修改(例如分号修改)
  • test: 测试用例新增、修改
  • build: 影响项目构建或依赖项修改
  • revert: 恢复上一次提交
  • ci: 持续集成相关文件修改
  • chore: 其他修改(不在上述类型中的修改)
  • release: 发布新版本
  • workflow: 工作流相关文件修改

参考资料:https://zhuanlan.zhihu.com/p/90281637

标签:重构,代码,规范,注释,修改,提交
From: https://www.cnblogs.com/liqi175/p/17547708.html

相关文章

  • 重塑未来的1课:组装式交付新引擎——智能化低代码平台
    摘要:智能化低代码必修课。紧跟低代码技术飞速发展——华为云Astro智能工作流惊艳HDC.Cloud2023!企业对未来智能化组装式交付的期待已不是空想。智能化低代码即将重新定义传统交付模式,密切连接AI科技与创造力。在HDC.Cloud2023华为云Astro分论坛,云计算大咖、行业翘楚科技提出一......
  • 对JS代码混淆加密的法律意义
    对JS代码混淆加密的法律意义你知道吗?JS代码经混淆加密之后,将得到法律层面的保护。这是因为:对加密的JS代码进行逆向破解,破解者将面临以下多种法律风险。1、侵权责任加密的JS代码或相关产品在涉及生产经营时,破解者可能侵害对方商业利益、技术机密等,被破解方可视受到的侵害起诉追......
  • GPT生产前端代码
    我让GPT生成一段前端代码:<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>Document</title><linkhref="https://cdn.quilljs.com/1.3.6/quill.snow.css"rel="......
  • Task的基本概念、使用方法和实例代码
    基本概念是一种用于异步编程的概念。Task的重要特点是可以在后台执行方法或操作,而不会阻塞主线程或UI线程。封装的异步操作,表示执行的操作正在进行。可以表示一个方法的返回值或者表示执行的操作已经完成。Task类的主要成员属性:TaskStatus、IsCanceled、IsCompleted、IsFa......
  • Visual C# 中XML注释换行
    只需将<para>标记用于诸如<summary>、<remarks>或<returns>等标记内即可 ///<summary>///基类(第1行)///<para>说明:(第2行)</para>///<para>封装一些常用的成员(第3行)</para>///<para>前面要用全角空格才能显示出空格来(第4行)</para>///</s......
  • 详解nvim内建LSP体系与基于nvim-cmp的代码补全体系
    2023年,nvim以及其生态已经发展的愈来愈完善了。nvim内置的LSP(以及具体的语言服务)加上众多插件,可以搭建出支持各种类型语法检查、代码补全、代码格式化等功能的IDE。网络上关于如何配置的文章很多,但本人发现绝大多数的文章仅仅停留在配置本身,没有深入的解释这些插件的作用和它们之......
  • 代码审计工具Fortify基本使用
    最近接触到一款代码审计的工具---FortifySCAandApplications22.2.0,现就其基本使用做一简单介绍!Fortify是一个应用安全测试软件,是MicroFocus旗下AST(应用程序安全测试)产品。Fortify能够提供静态和动态应用程序安全测试技术,以及运行时应用程序监控和保护功能,包括静态代码分......
  • <<代码整洁之道>> 读书笔记(1-4)
    整洁代码人工智能永远不能完全取代程序员,因为客户的需求总是模糊的,程序员不只是写代码,也会去讨论/设计需求和架构糟糕的代码会杀死项目,通常会在项目中后期体现出来,此时项目的生产力快速下降,影响正常迭代和问题修复对一个成熟的项目进行重新设计和编写,往往会分散......
  • 用代码玩转迷你图:手把手教你用编程语言打造简洁易读的数据图表!
    前言迷你图(MiniChart)最早起源于流程图和组织架构图中的一种简化图形,用于表示一个大型数据集合中的趋势和变化。随着数据可视化技术的发展,迷你图也被广泛应用在各种类型的数据图表中,例如折线图、柱形图、散点图等。迷你图通常具有小巧、简洁、直观的特点,能够在有限的空间内有效地展......
  • 《设计模式的运用》使用策略模式+工厂模式优化代码中的if else
    使用策略模式优化ifelse有这样一段逻辑function{for{if()if()if(if())...}}公司有的祖传的代码,是一段规则校验,校验的越多,每一个请求都会进来校验,加上后来的开发人员也......