8. 代码评注

针对项目的每一次Pull Request就相当于一次代码评审,评审以讨论的形式显示在Pull Request中。
在Pull Request中还能够看到对应的提交(一个或多个),并可以直接针对提交进行代码评注。对于采用集中式协同的项目,即使较少使用 Pull Request,也同样可以使用代码评注。代码评注会触发通知邮件给项目的开发者。
代码评注有两种形式,一种是针对整个提交的评注,另外一种是对代码进行逐行评注。

查看项目的提交历史,从中选择一个提交。在查看提交页面的最下方显示一个提交评注对话框,可以在其中写下评注。评注可以使用 Markdown 语法。添加评注后,所评注的提交的作者会收到通知邮件,提醒针对自己的提交有了新的评论。通过Web界面可以看到添加在提交下方的评注,并可以撰写新的评注展开讨论。评注者本人或提交的作者还可以编辑甚至删除评注

浏览提交,当鼠标置于任意一行代码时,在该行代码的左侧会显示一个添加注释的图标。点击该图标(用于添加逐行评注的图标),会显示添加逐行评注对话框。该评注对话框出现在两行代码之间,在其中写下评注。添加评注后,项目的开发人员同样会收到邮件通知。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,200评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 174,167评论 25 709
  • 1电影改编于葛水平的同名小说,拍摄地点在大山里,看到那山,还有她们住的土房子,觉得特别亲切,因为我小时候也住过差不...
    蓝天下的观望者阅读 1,118评论 0 2
  • 佯引围破纸上兵,出奇乘胜战必歼。 长平但逝机难进,只耐秦王不识军。 【2016,3,10。三古月南】 【QQ:15...
    三古月南阅读 295评论 0 1
  • 那时年少,不够成熟 总觉得我慢了半拍,跟不上你的脚步 从前特别喜欢一个人,甚至成为习惯,关注他的点滴,却不敢靠近。...
    萌哒哒的阅读 118评论 0 0