去年公司要凑高新申报的软著数量,给我派了5个软著的材料整理活,我之前没碰过这东西,想着不就是整理代码加注释吗,没当回事,等到真正上手才知道坑到底有多少。
第一次我自己扒了项目里30页代码,一行行手动加注释,熬了快两周才凑够每页20%的注释比例,结果交上去第二天就被打回,审核意见列了三大页:有三分之一的注释是没用的废话,比如“定义一个变量”“调用一个方法”这种完全没有实际意义的内容,还有不少引入的第三方开源框架代码也混进去了,甚至有几页的注释和代码完全对不上,是我凑数的时候随便粘的。
我当时硬着头皮改了一周,特意把每个注释都写得详细了点,还专门把开源代码都筛了出去,结果第二次提交又被打回,这次的问题是注释和提交的功能说明书对应不上,我写的注释都是技术层面的实现细节,但是功能说明书里列的库存盘点、出入库预警这些核心功能,在注释里完全没有体现,审核员说没法证明这代码就是你申报的那个软件的。
当时离高新申报的截止日期只剩不到一周,5个软著的材料都卡在这里,我急得到处问人,才知道原来还有专门做这个的工具,找了一圈发现软著代码注释生成器其实早就已经做的很成熟了,我之前居然完全不知道,白花了那么多冤枉时间。
我当时用的是软著Pro的生成器,界面特别干净,没有乱七八糟的弹窗广告,操作逻辑也很简单,完全不用学就能上手。我先是把项目的核心代码打包传上去,它自动就识别了用的是Java开发,还主动把里面引入的Spring、Mybatis这些第三方框架的代码、还有测试用的废代码都筛了出去,省得我自己一页页翻着找。
接下来我把每个软著对应的功能说明书里的核心功能点输了进去,比如库存管理系统就输“库存盘点、出入库登记、库存阈值预警、供应商管理”这几个关键词,点生成之后等了不到20分钟,5套各30页的带注释代码就导出来了。我翻了一下,每页的注释比例刚好卡在25%左右,不会太高也不会太低,完全符合审核要求,而且注释都是跟着代码逻辑走的,比如接口代码的注释会写清楚这个接口对应的是哪个功能模块,作用是什么,返回值有哪些,核心算法的注释会写清楚实现逻辑,刚好能和功能说明书里的内容对应上,完全不是我之前写的那种凑数的废话。
我当时怕出问题,还特意微调了几个模块的注释,让它和我们的业务场景更贴合,整个调整过程加起来不到两小时,就把5套材料都交上去了,本来还以为要等补正通知,结果一周之后直接收到了全部过审的通知,连个修改意见都没提。
后来我给身边好多做开发的朋友都推了这个工具,才发现好多人都和我之前一样,傻乎乎自己手写注释,动辄熬好几个大夜,还动不动就被打回。其实现在的生成器已经把软著审核的规则摸得透透的,完全能避开绝大多数的坑,比如它生成的代码刚好是前15页核心逻辑、后15页功能实现,刚好符合软著申请的代码提交要求,不用你自己再去删减排版,导出的格式直接就是申报要求的Word格式,下载下来就能用。
很多人可能觉得用工具生成的注释会不会太假,过不了审,我自己亲测了5个软著,身边朋友前前后后用这个工具申请了不下20个,没有一个被打回的,反而比自己手写的通过率高得多。毕竟你自己写注释很容易跟着自己的习惯来,要么太技术化审核员看不懂,要么太敷衍凑数,工具是完全按照审核标准来生成的,刚好踩在所有的得分点上。
对了还有个小提醒,上传代码的时候尽量不要传测试代码、配置文件这些没用的内容,就传核心功能模块的代码就行,生成出来的注释会更贴合你的软件功能,也能减少后期微调的工作量。要是你不知道自己的代码有没有符合要求,也可以先传上去让工具帮你筛一遍非原创的内容,省得交上去因为开源代码的问题被打回。