ShareComment: 自己编写的记录、阅读、分享Github代码注释和心得的工具

一、概述

[ShareComment] 是一款我设计开发的Chrome插件，用于自己平时记录、阅读、分享Github源码注释和心得的插件。通过它你可以带着代码上下文实时的阅读代码大佬的代码注释和心得，以达学习的目的。

如果你是大佬，也可以将自己对代码的注释、心得通过 [ShareComment] 标注在Github上，分享给其他人。

一睹为快

二、功能介绍

[ShareComment]目前包含：写模式、读模式，使用下拉列表切换。

写模式：在写模式时，用户可以标注自己对某一行或者一段代码的注释和心得。

读模式：在读模式时， 用户可以阅读其他人标注的一行代码或者一段代码的注释和心得。

二、安装与使用方法

1. 打开Chrome浏览器，

进入商店: https://chromewebstore.google.com/detail/github-share-comment/hgffmjgnmjjnojaedgifmloiflokaicj?pli=1, 点击安装。

2. 标注代码注释和心得。

选择下拉列表为写模式，

右键选择一行，点击“Upsert Comments”

编写你对这一行代码的注释和心得，然后点击“Submit”.

刷新页面后，有注释的行号会多"-c", 将鼠标移动上去，会显示注释。

3. 阅读大佬的注释和心得。

切换到阅读模式， 可以选择阅读其他人的注释和心得。

四、注意事项

1. 刷新页面。由于github是js异步加载数据，插件需要刷新页面才会生效。
2. 编写注释和心得时，可以跨行。比如

五、结语

这个插件完全是来自自己阅读的需求来做的。目前我主要做腾讯云上RocketMQ，如果你想阅读RocketMQ代码注释可以选我。

01 已注释RocketMQ代码 Pop：

https://github.com/apache/rocketmq/blob/release-5.2.0/broker/src/main/java/org/apache/rocketmq/broker/processor/PopMessageProcessor.java#L197

02 已注释RocketMQ代码 Ack：

https://github.com/apache/rocketmq/blob/release-5.2.0/broker/src/main/java/org/apache/rocketmq/broker/processor/AckMessageProcessor.java

03 已注释RocketMQ代码 Pop Revive Service ：

https://github.com/apache/rocketmq/blob/release-5.2.0/broker/src/main/java/org/apache/rocketmq/broker/processor/PopReviveService.java

04 已注释RocketMQ gRPC客户端生产者启动过程：https://github.com/apache/rocketmq-clients/blob/master/java/client/src/main/java/org/apache/rocketmq/client/java/example/ProducerNormalMessageExample.java

05 已注释RocketMQ gRPC ClientImpl：

https://github.com/apache/rocketmq-clients/blob/master/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientImpl.java