• 请不要在回答技术问题时复制粘贴 AI 生成的内容
x97bgt
V2EX  ›  程序员

看代码时怎么做笔记?

  •  
  •   x97bgt · May 16, 2019 via iPhone · 5447 views
    This topic created in 2732 days ago, the information mentioned may be changed or developed.

    公司的老项目没什么注释,自己看代码时会习惯性地把理解作为注释写进去。

    但我写的注释也没法合进分支里,一拉新代码就没了。

    这种大家怎么解决?否则看完一段时间,又得重新看。这种感觉太痛苦了。

    18 replies  •  2019-05-17 12:33:14 +08:00
    dfjslkjdf
    dfjslkjdf
    May 16, 2019
    1
    手动合并解决冲突?
    而且可以有两个版本?
    一个可运行的,一个有注释的,
    有注释的没必要版本完全一致,可以每次拉一部分,能看就好,不一定要能运行起来?
    iridescent0rsy
    iridescent0rsy
    May 16, 2019 via Android
    2
    最近再用的一个: codestream.com 编辑器插件,可以在旁边开个窗口写注释
    Vegetable
    Vegetable
    May 16, 2019
    3
    怎么就我觉得这注释合并进去也没什么问题吗
    x97bgt
    x97bgt
    OP
    May 16, 2019 via iPhone
    4
    @Vegetable #3 主要是注释是我自己的理解,个人学习的。也不知道对不对,合并进去是不是不大好?
    x97bgt
    x97bgt
    OP
    May 16, 2019 via iPhone
    5
    @dfjslkjdf #1 你指每次都把生产分支 merge 到注释分支???
    x97bgt
    x97bgt
    OP
    May 16, 2019 via iPhone
    6
    @iridescent0rsy #2 不错,我试试。
    hackyuan
    hackyuan
    May 16, 2019 via Android
    7
    你创建两个分支不就好了,一个分支用于提交,另外一个用于本地查看又不用提交,git 有一个记住操作后面自动合并的功能
    simen513
    simen513
    May 16, 2019
    8
    understand 软件里有注释,可以存到别的数据库引擎里,跟代码分开。
    marsgt
    marsgt
    May 16, 2019
    9
    VSCode 有个 Line Note 插件( https://github.com/tkrkt/linenote )好像是解决这个问题的,看了下是存在项目根目录的`.vscode`文件夹下边
    xiubin
    xiubin
    May 16, 2019
    10
    "但我写的注释也没法合进分支里,一拉新代码就没了。"

    不是很理解为什么一拉新代码注释就没了, 可以新建一个分支啊,你看代码就当时写需求,只不过这个需求你一直再写不合进你拉的那个分支的远程仓库里而已嘛
    xiubin
    xiubin
    May 16, 2019
    11
    @xiubin #10 哦 好吧 大概明白是平时开发中看代码,不方便切分支
    kevinhwang
    kevinhwang
    May 16, 2019
    12
    fork 代码,然后自己写注释。
    corvofeng
    corvofeng
    May 16, 2019 via iPhone
    13
    rebase 了解一下
    kiroter
    kiroter
    May 17, 2019
    14
    搞两份,一个注释来看,一个来写上传
    polebug
    polebug
    May 17, 2019 via Android
    15
    解决下冲突就好了
    gosansam
    gosansam
    May 17, 2019
    16
    @iridescent0rsy 老哥 我在 idea 里用这个插件 然后 codeStream 登录 写了一堆 comments 但是却没有展示 There are no codemarks in Current File,只有去 Channels 里面去找到 channel 才能看到,咋回事呀
    luozic
    luozic
    May 17, 2019 via iPhone
    17
    gerrit
    iridescent0rsy
    iridescent0rsy
    May 17, 2019
    18
    @gosansam 抱歉哦,我在 vscode 下用的,idea 没有试过
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1501 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 51ms · UTC 05:46 · PVG 13:46 · LAX 21:46 · JFK 00:46
    ♥ Do have faith in what you're doing.