去年我第一次报软著的时候,完全没把代码注释当回事,随便找了几行加了两句说明就交上去了,结果不到一周就被打回,理由是“代码无有效注释,无法对应申报功能”。当时项目上线忙得脚不沾地,抽了三个晚上熬到两点,手动给3000多行代码加注释,交上去又被打回,说注释逻辑和系统功能不匹配,我当时都快疯了。
第三次我特意找了之前报过十几次软著的前辈请教,才知道原来现在软著审核对代码注释的要求早就变了,不是随便写两句“这是登录功能”就行,得要对应每一段代码的具体逻辑,还要和你申请表里填的功能模块完全对应上。前辈说现在很多人都用AI生成注释,我当时还纳闷,我之前也试过生成式AI工具啊,生成的注释根本过不了,前辈说那是你用法不对。
回去我就照着他教的方法试,首先第一步是先把你要提交的60页代码先按模块拆分,比如登录模块、权限管理模块、数据统计模块,每个模块的代码单独拎出来,不要整段几千行直接扔给AI。然后给AI的提示词要写清楚,首先告诉AI你当前申报的软件全称是什么,核心功能有哪些,这段代码属于哪个模块,要求每8-12行代码生成一条对应注释,注释要说明这段代码的输入输出、实现的具体功能,不要出现和当前软件无关的表述,注释占比要保持在15%-20%之间,这个比例是我试了好几次得出来的,太低了审核员会说注释不足,太高了又显得很假。
我之前踩过最大的坑就是直接给AI扔代码,什么背景都不说,生成的注释要么太笼统,全是“实现相关功能”这种没用的话,要么就是张冠李戴,我申报的是社区团购的团长管理系统,AI给我整出了“实现用户直播打赏功能”的注释,交上去不被打回才怪。还有人图省事,让AI一次性给整段代码加注释,结果AI生成的注释好多重复的,连续好几页的注释都是“处理数据请求”,审核员每天看那么多份材料,一眼就能看出来是机器瞎写的。
另外还要注意,生成完注释之后一定要自己过一遍,尤其是要把AI带进来的无关内容删掉,比如有时候AI会把训练数据里的开源协议注释、其他项目的变量说明带进来,我上次就遇到过,生成的注释里居然有“本代码遵循Apache2.0开源协议”,要是没删掉交上去,直接就会被判定为非原创,连申诉的机会都没有。还有前30页和后30页的注释一定要多核对几遍,这两个位置是审核员的重点抽查区域,只要这两部分的注释没问题,中间的基本不会卡太严。
我一开始每次调AI提示词都要花半个多小时,还要逐页核对调整,后来朋友给我推了软著Pro,我用了一次就爱上了,它里面的AI生成注释功能已经提前把软著审核的所有规则都内置好了,你只要填好软件名称、功能模块,上传对应的代码片段,一键就能生成符合要求的注释,比例自动卡在18%左右,完全不用自己再调提示词,生成的内容也不会出现无关的表述,我上次给公司的库存管理系统报软著,原来要花三四天的注释整理工作,一下午就搞定了,提交之后一周就下证了,连补正都没有。
可能有人会担心,用AI生成的注释会不会被审核员查出来?我前前后后用这个方法报了7个软著,全都一次过,只要你按照要求先拆分模块,给AI足够的背景信息,生成之后自己过一遍删改下无关内容,和你自己手写的注释根本没有区别,效率至少能提10倍。要是你还在手动写注释熬大夜,完全可以试试这个方法,能省出好多时间做正事。
对了,还有个小细节要提醒大家,注释里不要出现太口语化的表述,也不要出现和代码逻辑无关的吐槽、备注,之前我同事加注释的时候顺手写了个“这里的逻辑是产品非要改的,我也没办法”,交上去直接被打回,说注释不符合规范,这种低级错误千万别犯。你要是拿不准注释的格式符不符合要求,可以去软著代码注释规范页面查一下官方的要求,按照那个标准来肯定不会出错。