V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
这是一个专门讨论 idea 的地方。

每个人的时间,资源是有限的,有的时候你或许能够想到很多 idea,但是由于现实的限制,却并不是所有的 idea 都能够成为现实。

那这个时候,不妨可以把那些 idea 分享出来,启发别人。
o0
V2EX  ›  奇思妙想

对代码和注释进行分离

  •  
  •   o0 · 2022-07-13 11:23:21 +08:00 · 3990 次点击
    这是一个创建于 867 天前的主题,其中的信息可能已经有所发展或是发生改变。
    由于不断受到资本家的铁拳打击,于是上班路上想到这个,将代码和注释分开保存,代码保持干净正常上传仓库,注释只存在本地,编写代码的时候又可以相对方便的查看、编辑注释(比如左右排列同步滚动)。

    不知道有没有类似工具或者插件
    26 条回复    2022-07-14 10:09:11 +08:00
    xuelu520
        1
    xuelu520  
       2022-07-13 11:33:23 +08:00   ❤️ 2
    2 份项目,一份正常带注释的代码。一份是用脚本清掉注释的。
    自己就在带注释的那份上开发。git 推那份不带注释的。
    cutepig
        2
    cutepig  
       2022-07-13 11:37:24 +08:00 via Android
    代码只是你一个人维护,有没有 code review?
    如果多人维护,或者有 code review 的话,很难做吧

    否则就简单了,完全可以改搞一个私人的代码仓库,但每次 release 软件之前从里面拿出代码混淆一下代码放到公司的库里面。写个脚本很简单
    NexTooo
        3
    NexTooo  
       2022-07-13 11:38:44 +08:00
    @cutepig 狠还是你狠。。。
    selca
        4
    selca  
       2022-07-13 11:47:27 +08:00   ❤️ 1
    直接提交反编译版本吧
    zr8657
        5
    zr8657  
       2022-07-13 11:51:11 +08:00
    多写点注释最后达到的效果差不多,反正代码更了注释也不更
    fzdwx
        6
    fzdwx  
       2022-07-13 11:56:18 +08:00   ❤️ 4
    idea 有个插件叫`private notes`可以试试
    Jaosn
        7
    Jaosn  
       2022-07-13 12:04:07 +08:00
    好像也不犯法吼,是个好思路
    FrankAdler
        8
    FrankAdler  
       2022-07-13 12:51:14 +08:00 via iPhone
    @xuelu520 报错的时候行号全是错的,查 bug 查到不想查
    masterclock
        9
    masterclock  
       2022-07-13 13:05:46 +08:00   ❤️ 1
    golang: 注释就不是代码?啊?!啊?!
    v23x
        10
    v23x  
       2022-07-13 13:07:57 +08:00
    注释很多时候是有害的....尤其是频繁变化的代码

    最好的代码应该是不需要注释都能看懂的代码 虽然这并不容易
    sun1991
        11
    sun1991  
       2022-07-13 13:46:50 +08:00   ❤️ 7
    是时候祭出这篇神作了: https://coderlmn.github.io/frontEndCourse/unmaintainable.html
    也是之前从 V2 保存的.
    flyqie
        12
    flyqie  
       2022-07-13 13:51:46 +08:00 via Android
    @masterclock

    哈哈哈,go 在这方面太惨了。

    cgo 和各种各样的 go:指令。

    真想清注释得单独区分出来,十分感人。
    titanlpy
        13
    titanlpy  
       2022-07-13 14:07:16 +08:00
    @sun1991 这个是真的牛逼
    danhahaha
        14
    danhahaha  
       2022-07-13 16:20:05 +08:00   ❤️ 1
    用粤语注释
    AX5N
        15
    AX5N  
       2022-07-13 16:25:09 +08:00
    直接手写一个 git 不就好了,你在上传过程中自动清理掉注释,缺点是没办法实现完整的 git 功能(麻烦)。
    TtTtTtT
        16
    TtTtTtT  
       2022-07-13 16:29:19 +08:00
    多大仇。。
    dcmi2021
        17
    dcmi2021  
       2022-07-13 16:36:19 +08:00
    @sun1991 服了......
    duke807
        18
    duke807  
       2022-07-13 16:43:40 +08:00 via Android   ❤️ 1
    @danhahaha
    jyutping.org 命名變量
    echoechoin
        19
    echoechoin  
       2022-07-13 18:16:19 +08:00
    https://stackoverflow.com/a/70526725/17792990 给你删除代码注释的方法
    loading
        20
    loading  
       2022-07-13 19:39:49 +08:00
    独立开发者:留注释
    打工人:被炒,马上就要先把你炒掉。
    darkengine
        21
    darkengine  
       2022-07-13 23:03:44 +08:00
    你说的这个。。。叫文档吧
    darksheep9527
        22
    darksheep9527  
       2022-07-13 23:29:38 +08:00 via Android
    推荐一个叫 notes 的 idea 付费插件,豆软开发的
    Yonker
        23
    Yonker  
       2022-07-14 04:00:44 +08:00 via iPhone
    除非复杂的逻辑会写写思路,通常不写注释
    xaplux
        24
    xaplux  
       2022-07-14 08:33:45 +08:00
    写个工具,参考 PostgreSQL 的 comment 语法,comment on codeId ,比如为 f 文件的第 m 行至第 n 行添加注释,然后 codeId 就由 f + m + n 生成一个 id
    xaplux
        25
    xaplux  
       2022-07-14 08:42:58 +08:00
    想了想,根据行号这种太局限,如果文件有变更就相对复杂了,特别协作的时候。
    尝试对要注释的部分求 hash 作为 codeId ?
    Yonker
        26
    Yonker  
       2022-07-14 10:09:11 +08:00 via iPhone
    @xaplux 注释每行统一前缀,全局替换吧,IDEA 可以自定义短语
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1526 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 17:14 · PVG 01:14 · LAX 09:14 · JFK 12:14
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.