看代码时怎么做笔记?

2019-05-16 20:19:30 +08:00
 x97bgt

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

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

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

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

不是很理解为什么一拉新代码注释就没了, 可以新建一个分支啊,你看代码就当时写需求,只不过这个需求你一直再写不合进你拉的那个分支的远程仓库里而已嘛
xiubin
2019-05-16 22:15:54 +08:00
@xiubin #10 哦 好吧 大概明白是平时开发中看代码,不方便切分支
kevinhwang
2019-05-16 22:20:04 +08:00
fork 代码,然后自己写注释。
corvofeng
2019-05-16 22:28:25 +08:00
rebase 了解一下
kiroter
2019-05-17 09:07:22 +08:00
搞两份,一个注释来看,一个来写上传
polebug
2019-05-17 09:14:37 +08:00
解决下冲突就好了
gosansam
2019-05-17 10:51:40 +08:00
@iridescent0rsy 老哥 我在 idea 里用这个插件 然后 codeStream 登录 写了一堆 comments 但是却没有展示 There are no codemarks in Current File,只有去 Channels 里面去找到 channel 才能看到,咋回事呀
luozic
2019-05-17 11:38:12 +08:00
gerrit
iridescent0rsy
2019-05-17 12:33:14 +08:00
@gosansam 抱歉哦,我在 vscode 下用的,idea 没有试过

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/564836

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX