一种代码注释管理方法和系统技术方案

本发明专利技术公开了一种代码注释管理方法和系统，系统包括分析端和至少一个开发端，其中：开发端获取目标代码文件的注释位置，并扫描目标代码文件中注释位置上是否包含注释信息；若注释位置上包含注释信息，开发端则检查注释信息是否符合预设标准格式；开发端对不包含注释信息的注释位置、不符合预设标准格式的注释信息以及符合预设标准格式的注释信息进行记录，并将得到的记录数据和目标代码文件发送至分析端；分析端基于记录数据判断目标代码文件是否符合预设测试条件；分析端在目标代码文件不符合预设测试条件时，标记目标代码文件不能进入测试阶段。本发明专利技术提供的技术方案，提高了不同研发人员对代码注释的统一性。研发人员对代码注释的统一性。研发人员对代码注释的统一性。

【技术实现步骤摘要】
一种代码注释管理方法和系统


[0001]本专利技术涉及软件开发领域，具体涉及一种代码注释管理方法和系统。

技术介绍

[0002]在代码开发过程中，由于各个开发者的设计逻辑不同，开发水平不一，开发环境差异，完成一个功能的代码开发，可能采用不同的代码书写方式，不同开发者之间代码会产生互相不可读的情况。而随着面向对象的设计开发方式的普及、项目的不断发展，也会使代码量不断增长。代码的可读性会越来越差，而在代码开发过程中添加详细的注释，对于代码项目的开发、交接、重构等具有现实意义。
[0003]而代码的注释方式因人而因，虽然很多开发语言提供了一些非强制性规范，但更多的是遵循开发者的开发习惯而定。不同的开发者查看他人的注释，或进行交流时，很有可能会产生描述不清楚、遗漏重要信息等情况。现有阶段，大部分企业会通过经验制定一份适应自己的开发规范，此开发规范中会涵盖代码注释管理规范，企业在代码开发过程中，开发人员会通过培训等方式学习开发规范，并在开发过程中使用规范。在代码开发结束后，再通过人工对代码注释情况进行检查，当代码注释不符合规范时，会提出整改意见，本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种代码注释管理方法，其特征在于，应用于开发端，所述方法包括：获取目标代码文件的注释位置，并扫描所述目标代码文件中所述注释位置上是否包含注释信息；若所述注释位置上包含所述注释信息，则检查所述注释信息是否符合预设标准格式；对不包含注释信息的注释位置、不符合所述预设标准格式的注释信息以及符合所述预设标准格式的注释信息进行记录，并将得到的记录数据和所述目标代码文件发送至分析端，以使所述分析端基于所述记录数据判断所述目标代码文件是否符合预设测试条件，并在所述目标代码文件不符合所述预设测试条件时，标记所述目标代码文件不能进入测试阶段。2.根据权利要求1所述的方法，其特征在于，所述获取目标代码文件的注释位置，包括：基于所述目标代码文件的语言类型从预存的多个代码扫描规则中提取对应的目标代码扫描规则；基于所述目标代码扫描规则中记录的类字段、方法字段、计划开发字段和文件字段获取所述目标代码文件中应当包含注释信息的所述注释位置。3.根据权利要求2所述的方法，其特征在于，所述检查所述注释信息是否符合预设标准格式，包括：若所述注释信息对应类字段、计划开发字段和文件字段，则检查所述注释信息是否包括描述注释，若包括所述描述注释则检查通过；若所述注释信息对应方法字段，则检查所述注释信息是否包括描述注释、参数注释和返回值注释，若包括所述描述注释、所述参数注释和所述返回值注释则检查通过；检查所述注释信息的字数是否超过预设字数，并检查所述注释信息中是否包含修改人信息，若超过所述预设字数并包含所述修改人信息则检查通过；当所有检查通过时，标注所述注释信息符合所述预设标准格式。4.根据权利要求1所述的方法，其特征在于，在所述获取目标代码文件的注释位置之前，所述方法还包括：在接收到输入的代码时，通过预设的注释检测插件对所述输入的代码进行扫描；基于扫描到的代码内容展示注释提示信息，以使外部人员基于所述注释提示信息添加注释信息；基于所述输入的代码和所述注释信息生成所述目标代码文件。5.一种代码注释管理方法，其特征在于，应用于分析端，所述方法包括：接收开发端发送的记录数据和目标代码文件，并通过所述记录数据判断所述目标代码文件是否符合预设测试条件；若所述目标代码文件不符合所述预设测试条件，则对所述目标代码文件进行标记，以表征所述目标代码文件不能进入测试阶段；其中，所述记录数据由所述开发端生...

【专利技术属性】
技术研发人员：杨晓明，
申请(专利权)人：北京自如信息科技有限公司，
类型：发明
国别省市：