乐于分享
好东西不私藏

CodeSucker:软著代码文档这破活,终于有人做成本地工具了

CodeSucker:软著代码文档这破活,终于有人做成本地工具了
申请过软著的兄弟应该懂,最烦的往往不是写代码,是整理那 60 页源程序材料。

前 30 页、后 30 页,每页至少 50 行,页眉还得放软件名和版本号,第一页得从程序开头起,最后一页还得收在程序结尾。手工搞一次,复制、删注释、分页、调 Word,啧,纯体力活。

最近刷到个国产开源项目 CodeSucker,专门收拾这个事。

项目文件夹直接拖进去,它会递归扫描目录,文件自己勾,Java、Python、Go、JS、TS、Vue、SQL 等 30 多种后缀都支持。超过 3000 行就自动取前 1500 + 后 1500,每 50 行硬分页,最后直接吐一个 60 页 docx。

东哥看到这种工具,第一个看的其实不是界面,而是:源码往哪儿走?

CodeSucker 这点挺舒服,扫描、清洗、分页、导出全在本机完成,不需要把项目传到什么陌生网站。它启动时会去 GitHub 查版本,但项目代码不上传。商业项目要办软著的话,这个区别很大。

细节也不是简单“代码拼 Word”。它能去空行、去注释,处理字符串里的 // 时不会傻乎乎当注释删掉;API Key、密码、内网 IP、手机号还能自动脱敏。项目里的 .gitignore 也会叠加进去,node_modules 这种东西不用自己一个个排除。

我这个老开发的毛病又犯了——这类批处理工具我还会看出错前有没有检查。它导出前会扫每页行数、末页内容、页眉、@author、Copyright 等信息,有风险能直接定位文件。这个比生成完再去 Word 里肉眼翻 60 页省事多了。

目前支持 macOS 和 Windows,Apache-2.0,免费开源。macOS 安装包还没做苹果签名,第一次打开可能得手动放行,这个先提醒一下。

项目还挺年轻,但如果你最近真在弄软著,这种工具比在线上传整套源码让我踏实得多。

Github地址:fanbuz/codesucker