【编码规范】提交代码的注释规则

最新推荐文章于 2025-11-14 13:33:45 发布
原创 最新推荐文章于 2025-11-14 13:33:45 发布 · 2.7k 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#编码规范 #项目规范

本文介绍了一种用于规范代码提交注释的方法，该方法通过指定详细的格式来确保每次提交的信息都包含版本类型、任务编号及简介等内容，以便于团队成员理解和追踪。

规范下项目开发版本提交时的注释规则

目前使用worktile管理项目任务，使用阿里云code托管代码，并使用服务绑定将阿里云code提交信息发送到worktile群组中进行监控。


代码提交时，注释的具体格式为：

版本类型 worktile任务编号 任务标题（简介）


例如：

修正错误 #任务编号 任务标题

新增功能 #任务编号 任务标题

重构代码 #任务编号 任务标题

优化改善 #任务编号 任务标题

配置环境 #任务编号 任务标题


合并调试 #无任务编号 合并和调整内容

创建仓库 #无任务编号 创建内容


*如有不足，可申请添加

svn强制写注释才能提交代码
01-25
svn强制写注释才能提交代码 不写注释就报错 并且提交不成功
git提交代码注释规范
01-12
git提交代码注释规范、git提交常用操作的规范指南、[A] 新增 ：(新加入的需求) [M] 修改 ：( 修改或者重构代码) [D] 删除 ：(删除多余的文件 ) [F] 修复 ：(修复bug)
代码规范：代码提交注解规范
qq_31314583的博客
06-02 860
Type:Scope:Subject:举例： 1、feat(policy): 增加xxx策略
Git Cola项目贡献指南：代码提交规范与最佳实践
最新发布
gitblog_00857的博客
11-14 606
Git Cola是一个基于Python和Qt开发的图形化Git客户端工具，为开发者提供了直观的版本控制操作界面。作为开源项目，它遵循严格的代码规范和质量要求，确保项目长期维护的可持续性。 ## 代码提交规范 ### 1. 原子性提交原则 每个提交应当只包含一个逻辑变更单元，避免将多个不相关的修改混在同一个提交中。这种原子性提交有助于： - 更精准的回溯和问题定位 - 更清晰的代码审查 -
安全生产：提交代码需加说明
码出幸福人生
08-06 203
遇到这么一个问题，出错之后排查代码，然后查看提交的代码记录，完全忘记之前提交的代码是干什么的了。 因为这个问题，对每次提交的代码加注释，说明提交的代码是干什么的，方便日后遇到问题时进行排查。 所以日后，不论是用svn还是git，提交代码的时候一定要求必须加说明，作为一种项目管理的手段。...
规范的代码提交信息说明
lshdp的博客
08-08 166
【代码】规范的代码提交信息说明。
Java编码规范&代码检查规则项.rar
06-11
Java编程语言在全球软件开发领域占据着重要地位，为了确保代码的质量、可读性和维护性，遵循一定的编码规范和代码检查规则至关重要。这份"Java编码规范&代码检查规则项.rar"压缩包包含了两个关键文档，"Java编码规范...
微软一站式代码示例编程规范.rar_微软代码规范_编码规范
07-14
编码规范是软件开发中不可或缺的一部分，它为开发者提供了一套统一的编写代码的标准和指南，确保了代码的可读性、可维护性和团队协作的效率。微软作为全球领先的软件公司，其编码规范对业界有着深远的影响。这份...
精选资源
.net编码规范整理规则
06-22
.NET 编码规范是开发高质量、可维护代码的基础，它涉及到命名规范、编码规范、注释规约以及代码提交和提测规约等多个方面。以下是对这些规范的详细说明： **命名规范：** 1. 类名、接口名、枚举名、结构体名等全局...
团队文档及编码规范.zip_团队编码规范_编码规范
09-21
本资料“团队文档及编码规范.zip”包含了作者针对团队编码制定的一套详细规则，旨在为开发者提供一套明确的指导方针。 编码规范通常涵盖以下几个主要方面： 1. **命名规范**：这是编码规范的基础，涵盖了变量、...
精选资源
百度前端代码规范.pdf
04-13
HTML编码规范可能关注标签的闭合、属性的书写、代码的注释等，CSS编码规范可能关注选择器的命名、属性的排序、简写属性的使用等，而Less编码规范则可能涉及变量的使用、混合宏的编写等。 E-JSON数据传输标准是为了...
项目开发规范（编码规范、命名规范、安全规范、前端优化、源码提交规范、代码维护规范、产品发布规范）...
weixin_34324081的博客
06-15 913
第一节：编码过程的命名约定（编码命名规范） ====================================================================================== ====================================PHP编码规范========================================...
git提交代码-commit备注规范
qq_41910413的博客
03-13 969
git commit提交备注类型：
git commit规范指南 提交代码备注规范
qq_39695210的博客
05-21 179
git commit规范指南 提交代码备注规范
git 提交信息规范
Aimee的博客
12-12 417
一、开发时必须从最新代码上拉取功能分支，以分支-用户-功能为新的分支名 结构：xxx-xxx-xxx 例子：dev-aimee-user-create 二、提交分支时注明：动作类型（新增、修改、删除、重构）+用户故事+改动明细，禁止填写无意义或不相关的注明； 结构：【xxx】（xxx）xxxxx 例子：【feat】(用户新增): 新增用户 【type】(<scope>): ...
linux svn 强制添加备注(注释)提交
热门推荐
千叶飘的空中楼阁
06-02 1万+
Linux版本： 1、在svn的hooks目录下新建一个名为pre-commit的文件并为其添加执行权限 2、pre-commit文件的内容如下： #!/bin/sh REPOS="$1" TXN="$2" SVNLOOK=/opt/CollabNet_Subversion/bin/svnlook LOGMSG=$($SVNLOOK log -t "$TXN" "$REPOS" | grep "[...
Git提交规范指南
宫宏伟的博客
08-16 773
scope选填表示commit的作用范围，如数据层、视图层，也可以是目录名称。subject必填用于对commit进行简短的描述。
SVN提交更新的一个准则
weixin_30294709的博客
09-22 143
查阅了一下网络和博客园，发现还没有一个明确地指导源码管理提交准则的相关文章，因此斗胆整理了一部分自己平时开发管理的心得，加上查阅了部分英文资料写了一个不算很完善的SVN提交准则。 负责而谨慎地提交自己的代码 SVN更新的原则是要随时更新，随时提交。当完成了一个小功能，能够通过编译并且并且自己测试之后，谨慎地提交。 如果提交过程中产生了冲突，则需要同之前的开发人员联系，两个人一起协商解决...
程序员必备 - Git代码提交规范
陈卓fighting!!!
09-20 1443
1）每次提交只能包含同一类别的改动，不要把不同类型的改动混合在同一次提交中。2）每次提交不能超过3个问题，确保每个提交的改动清晰明确。3）提交信息不符合规范时，可以使用修改，或者使用回退提交。
JavaScript编码规范与实用教程源代码解析
标题和描述中提到的“js javascript 实用教程 资料 编码规范 源代码”指向的内容涵盖了JavaScript编程语言的学习资源、实际应用案例、编码规范指导和实例代码分享。下面我将详细解释这些知识点： ### JavaScript...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值