Re: About the comments coverage of the code

[Xin Wang]

> So we need to let them know the role of a class or a method clearly when
we
only look at the doc.

I think a good way is to add the report generated by Javadoc to the website
dubbo. apache. org,
we can see the effect in real time。 "what you do is what you get",。

yuhang xiu  于2018年12月20日周四 上午11:05写道：

> Hi, huxing
>
> I agree with what you said, we don't need to strictly follow some kind of
> guidance.
>
> But I think we need a very detailed doc. And this doc is based on code, and
> may be more oriented to developers.
> So we need to let them know the role of a class or a method clearly when we
> only look at the doc.
> I'd like take a look at these doc prs and give some suggestions.
>
> Regarding the goal, I think we can increase the doc coverage rate to 45%
> first, and increase the coverage by about 20% first.
> :)
>
> Huxing Zhang  于2018年12月20日周四 上午10:20写道：
>
> > Hi，
> >
> > On Wed, Dec 19, 2018 at 8:48 PM yuhang xiu  wrote:
> > >
> > > Hi, all
> > >
> > > Recently I have seen a few pr about doc. Several of them have been
> > merged.
> > > I think we have two issues to discuss:
> > > 1. What kind of comments should we add?
> > > 2. We need to define a goal.
> > >
> > > Regarding question one, I personally think that we should:
> > > 1. Explain each param of the method
> > > 2. Explain the special usage of some classes. For example, when adding
> > the
> > > doc of SerializableClassRegistry, we need to doc that this class only
> > works
> > > when using fst and kryo serialization.
> > > 3. We need to use @link or @code for the association when the class
> > > (method) is associated with other classes (methods).
> >
> > Perhaps following some guide like [1] and [2]. But I don't think we
> > should follow it strictly.
> > If using IDE like Intellij IDEA, you can easily create customized
> > Javadoc template[3], with some boilerplate content like params, return
> > values.
> >
> > >
> > > Regarding question two, I don't have a idea. Perhaps doc coverage is
> 40%
> > is
> > > a good choice. What do you think?
> >
> > Do you mean the average doc coverage,  acoording to [4], I see there
> > is an average of 28.8% java coverage, setting the goal of average
> > coverage to 40%~50% looks good to me. We can do it step by step :)
> >
> > [1] https://www.baeldung.com/javadoc
> > [2]
> >
> https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide
> > [3]
> >
> https://stackoverflow.com/questions/17607925/how-configure-intellij-idea-javadoc-templates
> > [4] https://github.com/apache/incubator-dubbo/issues/2884
> >
> > >
> > >
> > > yuhang xiu  于2018年12月18日周二 下午4:21写道：
> > >
> > > > Hello, Dave.
> > > >
> > > > (2) Have any committers reached out to the users who had trouble with
> > code
> > > >> comments to confirm these efforts will meet their concerns?
> > > >>
> > > >
> > > > I used to talk to them, but I forgot to ask them about what kind of
> > docs
> > > > are better.
> > > >
> > > > But don't worry, I still have their contact details.
> > > > I will communicate with them and hope that they will bring their
> > opinions
> > > > here to better work for developers who add comments.
> > > >
> >
> >
> >
> > --
> > Best Regards！
> > Huxing
> >
>

Re: About the comments coverage of the code

[yuhang xiu]

Hi, huxing

I agree with what you said, we don't need to strictly follow some kind of
guidance.

But I think we need a very detailed doc. And this doc is based on code, and
may be more oriented to developers.
So we need to let them know the role of a class or a method clearly when we
only look at the doc.
I'd like take a look at these doc prs and give some suggestions.

Regarding the goal, I think we can increase the doc coverage rate to 45%
first, and increase the coverage by about 20% first.
:)

Huxing Zhang  于2018年12月20日周四 上午10:20写道：

> Hi，
>
> On Wed, Dec 19, 2018 at 8:48 PM yuhang xiu  wrote:
> >
> > Hi, all
> >
> > Recently I have seen a few pr about doc. Several of them have been
> merged.
> > I think we have two issues to discuss:
> > 1. What kind of comments should we add?
> > 2. We need to define a goal.
> >
> > Regarding question one, I personally think that we should:
> > 1. Explain each param of the method
> > 2. Explain the special usage of some classes. For example, when adding
> the
> > doc of SerializableClassRegistry, we need to doc that this class only
> works
> > when using fst and kryo serialization.
> > 3. We need to use @link or @code for the association when the class
> > (method) is associated with other classes (methods).
>
> Perhaps following some guide like [1] and [2]. But I don't think we
> should follow it strictly.
> If using IDE like Intellij IDEA, you can easily create customized
> Javadoc template[3], with some boilerplate content like params, return
> values.
>
> >
> > Regarding question two, I don't have a idea. Perhaps doc coverage is 40%
> is
> > a good choice. What do you think?
>
> Do you mean the average doc coverage,  acoording to [4], I see there
> is an average of 28.8% java coverage, setting the goal of average
> coverage to 40%~50% looks good to me. We can do it step by step :)
>
> [1] https://www.baeldung.com/javadoc
> [2]
> https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide
> [3]
> https://stackoverflow.com/questions/17607925/how-configure-intellij-idea-javadoc-templates
> [4] https://github.com/apache/incubator-dubbo/issues/2884
>
> >
> >
> > yuhang xiu  于2018年12月18日周二 下午4:21写道：
> >
> > > Hello, Dave.
> > >
> > > (2) Have any committers reached out to the users who had trouble with
> code
> > >> comments to confirm these efforts will meet their concerns?
> > >>
> > >
> > > I used to talk to them, but I forgot to ask them about what kind of
> docs
> > > are better.
> > >
> > > But don't worry, I still have their contact details.
> > > I will communicate with them and hope that they will bring their
> opinions
> > > here to better work for developers who add comments.
> > >
>
>
>
> --
> Best Regards！
> Huxing
>

Re: About the comments coverage of the code

[Ian Luo]

As I mentioned earlier, we should focus javadoc on API level and existing
comments first.

Thanks,
-Ian.

On Thu, Dec 20, 2018 at 10:20 AM Huxing Zhang  wrote:

> Hi，
>
> On Wed, Dec 19, 2018 at 8:48 PM yuhang xiu  wrote:
> >
> > Hi, all
> >
> > Recently I have seen a few pr about doc. Several of them have been
> merged.
> > I think we have two issues to discuss:
> > 1. What kind of comments should we add?
> > 2. We need to define a goal.
> >
> > Regarding question one, I personally think that we should:
> > 1. Explain each param of the method
> > 2. Explain the special usage of some classes. For example, when adding
> the
> > doc of SerializableClassRegistry, we need to doc that this class only
> works
> > when using fst and kryo serialization.
> > 3. We need to use @link or @code for the association when the class
> > (method) is associated with other classes (methods).
>
> Perhaps following some guide like [1] and [2]. But I don't think we
> should follow it strictly.
> If using IDE like Intellij IDEA, you can easily create customized
> Javadoc template[3], with some boilerplate content like params, return
> values.
>
> >
> > Regarding question two, I don't have a idea. Perhaps doc coverage is 40%
> is
> > a good choice. What do you think?
>
> Do you mean the average doc coverage,  acoording to [4], I see there
> is an average of 28.8% java coverage, setting the goal of average
> coverage to 40%~50% looks good to me. We can do it step by step :)
>
> [1] https://www.baeldung.com/javadoc
> [2]
> https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide
> [3]
> https://stackoverflow.com/questions/17607925/how-configure-intellij-idea-javadoc-templates
> [4] https://github.com/apache/incubator-dubbo/issues/2884
>
> >
> >
> > yuhang xiu  于2018年12月18日周二 下午4:21写道：
> >
> > > Hello, Dave.
> > >
> > > (2) Have any committers reached out to the users who had trouble with
> code
> > >> comments to confirm these efforts will meet their concerns?
> > >>
> > >
> > > I used to talk to them, but I forgot to ask them about what kind of
> docs
> > > are better.
> > >
> > > But don't worry, I still have their contact details.
> > > I will communicate with them and hope that they will bring their
> opinions
> > > here to better work for developers who add comments.
> > >
>
>
>
> --
> Best Regards！
> Huxing
>

Re: About the comments coverage of the code

[Huxing Zhang]

Hi，

On Wed, Dec 19, 2018 at 8:48 PM yuhang xiu  wrote:
>
> Hi, all
>
> Recently I have seen a few pr about doc. Several of them have been merged.
> I think we have two issues to discuss:
> 1. What kind of comments should we add?
> 2. We need to define a goal.
>
> Regarding question one, I personally think that we should:
> 1. Explain each param of the method
> 2. Explain the special usage of some classes. For example, when adding the
> doc of SerializableClassRegistry, we need to doc that this class only works
> when using fst and kryo serialization.
> 3. We need to use @link or @code for the association when the class
> (method) is associated with other classes (methods).

Perhaps following some guide like [1] and [2]. But I don't think we
should follow it strictly.
If using IDE like Intellij IDEA, you can easily create customized
Javadoc template[3], with some boilerplate content like params, return
values.

>
> Regarding question two, I don't have a idea. Perhaps doc coverage is 40% is
> a good choice. What do you think?

Do you mean the average doc coverage,  acoording to [4], I see there
is an average of 28.8% java coverage, setting the goal of average
coverage to 40%~50% looks good to me. We can do it step by step :)

[1] https://www.baeldung.com/javadoc
[2] 
https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide
[3] 
https://stackoverflow.com/questions/17607925/how-configure-intellij-idea-javadoc-templates
[4] https://github.com/apache/incubator-dubbo/issues/2884

>
>
> yuhang xiu  于2018年12月18日周二 下午4:21写道：
>
> > Hello, Dave.
> >
> > (2) Have any committers reached out to the users who had trouble with code
> >> comments to confirm these efforts will meet their concerns?
> >>
> >
> > I used to talk to them, but I forgot to ask them about what kind of docs
> > are better.
> >
> > But don't worry, I still have their contact details.
> > I will communicate with them and hope that they will bring their opinions
> > here to better work for developers who add comments.
> >



-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[雷舜宇]

I don't think it's just parameters. For example, if there are some property
settings, if you pass SPI injection, many hidden dependency injections,
plus comments are not conducive to source learning, how do you artificially?
我认为不单单是参数这些,比如有一些属性的设置,如果通过SPI注入,很多隐似的依赖注入,加上注释是不是跟有利于源码学习,你们是怎么人为的呢?

竹子  于2018年12月19日周三 下午8:50写道：

> I think so 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On 12/19/2018 20:41,
> yuhang xiu wrote: Hi, all Recently I have seen a few pr about doc. Several
> of them have been merged. I think we have two issues to discuss: 1. What
> kind of comments should we add? 2. We need to define a goal. Regarding
> question one, I personally think that we should: 1. Explain each param of
> the method 2. Explain the special usage of some classes. For example, when
> adding the doc of SerializableClassRegistry, we need to doc that this class
> only works when using fst and kryo serialization. 3. We need to use @link
> or @code for the association when the class (method) is associated with
> other classes (methods). Regarding question two, I don't have a idea.
> Perhaps doc coverage is 40% is a good choice. What do you think? yuhang xiu
>  于2018年12月18日周二 下午4:21写道： > Hello, Dave. > > (2) Have
> any committers reached out to the users who had trouble with code >>
> comments to confirm these efforts will meet their concerns? >> > > I used
> to talk to them, but I forgot to ask them about what kind of docs > are
> better. > > But don't worry, I still have their contact details. > I will
> communicate with them and hope that they will bring their opinions > here
> to better work for developers who add comments. >

Re: About the comments coverage of the code

[竹子]

I think so 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On 12/19/2018 20:41, yuhang 
xiu wrote: Hi, all Recently I have seen a few pr about doc. Several of them 
have been merged. I think we have two issues to discuss: 1. What kind of 
comments should we add? 2. We need to define a goal. Regarding question one, I 
personally think that we should: 1. Explain each param of the method 2. Explain 
the special usage of some classes. For example, when adding the doc of 
SerializableClassRegistry, we need to doc that this class only works when using 
fst and kryo serialization. 3. We need to use @link or @code for the 
association when the class (method) is associated with other classes (methods). 
Regarding question two, I don't have a idea. Perhaps doc coverage is 40% is a 
good choice. What do you think? yuhang xiu  于2018年12月18日周二 
下午4:21写道： > Hello, Dave. > > (2) Have any committers reached out to the users 
who had trouble with code >> comments to confirm these efforts will meet their 
concerns? >> > > I used to talk to them, but I forgot to ask them about what 
kind of docs > are better. > > But don't worry, I still have their contact 
details. > I will communicate with them and hope that they will bring their 
opinions > here to better work for developers who add comments. >

Re: About the comments coverage of the code

[yuhang xiu]

Hi, all

Recently I have seen a few pr about doc. Several of them have been merged.
I think we have two issues to discuss:
1. What kind of comments should we add?
2. We need to define a goal.

Regarding question one, I personally think that we should:
1. Explain each param of the method
2. Explain the special usage of some classes. For example, when adding the
doc of SerializableClassRegistry, we need to doc that this class only works
when using fst and kryo serialization.
3. We need to use @link or @code for the association when the class
(method) is associated with other classes (methods).

Regarding question two, I don't have a idea. Perhaps doc coverage is 40% is
a good choice. What do you think?


yuhang xiu  于2018年12月18日周二 下午4:21写道：

> Hello, Dave.
>
> (2) Have any committers reached out to the users who had trouble with code
>> comments to confirm these efforts will meet their concerns?
>>
>
> I used to talk to them, but I forgot to ask them about what kind of docs
> are better.
>
> But don't worry, I still have their contact details.
> I will communicate with them and hope that they will bring their opinions
> here to better work for developers who add comments.
>

Re: About the comments coverage of the code

[yuhang xiu]

Hello, Dave.

(2) Have any committers reached out to the users who had trouble with code
> comments to confirm these efforts will meet their concerns?
>

I used to talk to them, but I forgot to ask them about what kind of docs
are better.

But don't worry, I still have their contact details.
I will communicate with them and hope that they will bring their opinions
here to better work for developers who add comments.

Re: About the comments coverage of the code

[Dave Fisher]

Hi -

Here is one of your mentors dropping in with comments.

(1) I really like this thread!
(2) Have any committers reached out to the users who had trouble with code 
comments to confirm these efforts will meet their concerns?
(3) I’m not saying increased these efforts are wrong.

I’ve not read everything so apologies if I’ve missed anything.

Best Regards,
Dave


Sent from my iPhone

> On Dec 17, 2018, at 10:42 PM, Huxing Zhang  wrote:
> 
> Hi,
> 
>> On Tue, Dec 18, 2018 at 2:15 PM yuhang xiu  wrote:
>> 
>> Hi, all
>> I have now divided the work according to the module, and have established
>> the issue,
>> their number is from https://github.com/apache/incubator-dubbo/issues/2991,
>> to issue 3002.
>> They have all been labeled with help wanted and good first issue. Let us
>> see who is willing to complete these tasks.
>> 
>> 
>> The other thing, I personally think that we should mainly let the
>> annotations cover the master branch and cover the 2.6.x branch if the code
>> changes little.
>> Because we have completed many new functions on the master branch,
>> some are not compatible with the 2.6.x branch, we need to check the code on
>> the 2.6.x branch during the review.
>> If the comments can be shared, we need to remind the submitter. Let them
>> submit the comments to the 2.6.x branch as well.
>> What do you think?
> 
> +1
> 
>> 
>> yuhang xiu  于2018年12月11日周二 上午10:02写道：
>> 
>>> Ok, huxing
>>> I'd like take some time to do this.
>>> 
>>> Huxing Zhang  于2018年12月10日周一 下午11:43写道：
>>> 
> On Mon, Dec 10, 2018 at 7:14 PM yuhang xiu  wrote:
> 
> Hi,
> @zhuzi  @shunyumaple
> You are welcome to claim a new job.
> 
> We currently have a project, but I have not yet divided it. I think we
 need
> a discussion about how to divide tasks.
> @huxing @beiwei Can you give some advice? I personally think that you
 can
> divide by module
 
 +1 Using module looks good to me.
 
> but the work of a module can be done by multiple people,
 
 If there is multiple contributors working on the same module, we can
 even break it down by package name.
 We can do this only when it happen.
 
> as long as there is no conflict.
> 
> 
> 
> 竹子  于2018年12月10日周一 下午2:34写道：
> 
>> 我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On
>> 12/10/2018 14:28, yuhang xiu wrote: very nice. If there is any
 progress,
>> you can tell us here. 雷舜宇  于2018年12月10日周一
>> 下午12:03写道： > I said that I am currently doing the service-completed
>> comments completion > work. If there is a problem, I will exchange
 this on
>> the mailing list. > > 田 小波 
 于2018年12月10日周一
>> 上午10:03写道： > > > OK, I will submit a PR tomorrow. > > > > > 在
>> 2018年12月9日，下午4:50，Ian Luo  写道： > > > > > > I will
 take
>> a look, and talk to you on pull request. > > > > > > -Ian. > > > > >
> On
>> Fri, Dec 7, 2018 at 6:11 PM 田 小波  >
 wrote: >
 Ian: > > >> I will make some simple changes to these
 articles
>> and submit them to > > >> dubbo-website. Limited to personal
 abilities, if
>> there are any > mistakes > > in > > >> the article, please help to
 modify
>> and improve. > > >> > > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给 > >
>> dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > > >> > > >> Thanks!
 
>> Xiaobo > > >> > > >>> Pls. go ahead to submit your articles: > > >>>
>> 
> Then we can involve other peoples in the community to join the >
>> effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, >
 
>> -Ian. > > >> > > > > >
 
 
 
 --
 Best Regards！
 Huxing
 
>>> 
> 
> 
> 
> -- 
> Best Regards！
> Huxing

Re: About the comments coverage of the code

[Huxing Zhang]

Hi,

On Tue, Dec 18, 2018 at 2:15 PM yuhang xiu  wrote:
>
> Hi, all
> I have now divided the work according to the module, and have established
> the issue,
> their number is from https://github.com/apache/incubator-dubbo/issues/2991,
> to issue 3002.
> They have all been labeled with help wanted and good first issue. Let us
> see who is willing to complete these tasks.
>
>
> The other thing, I personally think that we should mainly let the
> annotations cover the master branch and cover the 2.6.x branch if the code
> changes little.
> Because we have completed many new functions on the master branch,
> some are not compatible with the 2.6.x branch, we need to check the code on
> the 2.6.x branch during the review.
> If the comments can be shared, we need to remind the submitter. Let them
> submit the comments to the 2.6.x branch as well.
> What do you think?

+1

>
> yuhang xiu  于2018年12月11日周二 上午10:02写道：
>
> > Ok, huxing
> > I'd like take some time to do this.
> >
> > Huxing Zhang  于2018年12月10日周一 下午11:43写道：
> >
> >> On Mon, Dec 10, 2018 at 7:14 PM yuhang xiu  wrote:
> >> >
> >> > Hi,
> >> > @zhuzi  @shunyumaple
> >> > You are welcome to claim a new job.
> >> >
> >> > We currently have a project, but I have not yet divided it. I think we
> >> need
> >> > a discussion about how to divide tasks.
> >> > @huxing @beiwei Can you give some advice? I personally think that you
> >> can
> >> > divide by module
> >>
> >> +1 Using module looks good to me.
> >>
> >> > but the work of a module can be done by multiple people,
> >>
> >> If there is multiple contributors working on the same module, we can
> >> even break it down by package name.
> >> We can do this only when it happen.
> >>
> >> > as long as there is no conflict.
> >> >
> >> >
> >> >
> >> > 竹子  于2018年12月10日周一 下午2:34写道：
> >> >
> >> > > 我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On
> >> > > 12/10/2018 14:28, yuhang xiu wrote: very nice. If there is any
> >> progress,
> >> > > you can tell us here. 雷舜宇  于2018年12月10日周一
> >> > > 下午12:03写道： > I said that I am currently doing the service-completed
> >> > > comments completion > work. If there is a problem, I will exchange
> >> this on
> >> > > the mailing list. > > 田 小波 
> >> 于2018年12月10日周一
> >> > > 上午10:03写道： > > > OK, I will submit a PR tomorrow. > > > > > 在
> >> > > 2018年12月9日，下午4:50，Ian Luo  写道： > > > > > > I will
> >> take
> >> > > a look, and talk to you on pull request. > > > > > > -Ian. > > > > >
> >> > On
> >> > > Fri, Dec 7, 2018 at 6:11 PM 田 小波  >
> >> wrote: >
> >> > > > > > > >> Ian: > > >> I will make some simple changes to these
> >> articles
> >> > > and submit them to > > >> dubbo-website. Limited to personal
> >> abilities, if
> >> > > there are any > mistakes > > in > > >> the article, please help to
> >> modify
> >> > > and improve. > > >> > > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给 > >
> >> > > dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > > >> > > >> Thanks!
> >> > > >>
> >> > > Xiaobo > > >> > > >>> Pls. go ahead to submit your articles: > > >>>
> >> > >
> >> > > >>> Then we can involve other peoples in the community to join the >
> >> > > effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, >
> >> > >>>
> >> > > -Ian. > > >> > > > > >
> >>
> >>
> >>
> >> --
> >> Best Regards！
> >> Huxing
> >>
> >



-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[yuhang xiu]

Hi, all
I have now divided the work according to the module, and have established
the issue,
their number is from https://github.com/apache/incubator-dubbo/issues/2991,
to issue 3002.
They have all been labeled with help wanted and good first issue. Let us
see who is willing to complete these tasks.


The other thing, I personally think that we should mainly let the
annotations cover the master branch and cover the 2.6.x branch if the code
changes little.
Because we have completed many new functions on the master branch,
some are not compatible with the 2.6.x branch, we need to check the code on
the 2.6.x branch during the review.
If the comments can be shared, we need to remind the submitter. Let them
submit the comments to the 2.6.x branch as well.
What do you think?

yuhang xiu  于2018年12月11日周二 上午10:02写道：

> Ok, huxing
> I'd like take some time to do this.
>
> Huxing Zhang  于2018年12月10日周一 下午11:43写道：
>
>> On Mon, Dec 10, 2018 at 7:14 PM yuhang xiu  wrote:
>> >
>> > Hi,
>> > @zhuzi  @shunyumaple
>> > You are welcome to claim a new job.
>> >
>> > We currently have a project, but I have not yet divided it. I think we
>> need
>> > a discussion about how to divide tasks.
>> > @huxing @beiwei Can you give some advice? I personally think that you
>> can
>> > divide by module
>>
>> +1 Using module looks good to me.
>>
>> > but the work of a module can be done by multiple people,
>>
>> If there is multiple contributors working on the same module, we can
>> even break it down by package name.
>> We can do this only when it happen.
>>
>> > as long as there is no conflict.
>> >
>> >
>> >
>> > 竹子  于2018年12月10日周一 下午2:34写道：
>> >
>> > > 我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On
>> > > 12/10/2018 14:28, yuhang xiu wrote: very nice. If there is any
>> progress,
>> > > you can tell us here. 雷舜宇  于2018年12月10日周一
>> > > 下午12:03写道： > I said that I am currently doing the service-completed
>> > > comments completion > work. If there is a problem, I will exchange
>> this on
>> > > the mailing list. > > 田 小波 
>> 于2018年12月10日周一
>> > > 上午10:03写道： > > > OK, I will submit a PR tomorrow. > > > > > 在
>> > > 2018年12月9日，下午4:50，Ian Luo  写道： > > > > > > I will
>> take
>> > > a look, and talk to you on pull request. > > > > > > -Ian. > > > > >
>> > On
>> > > Fri, Dec 7, 2018 at 6:11 PM 田 小波  >
>> wrote: >
>> > > > > > > >> Ian: > > >> I will make some simple changes to these
>> articles
>> > > and submit them to > > >> dubbo-website. Limited to personal
>> abilities, if
>> > > there are any > mistakes > > in > > >> the article, please help to
>> modify
>> > > and improve. > > >> > > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给 > >
>> > > dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > > >> > > >> Thanks!
>> > > >>
>> > > Xiaobo > > >> > > >>> Pls. go ahead to submit your articles: > > >>>
>> > >
>> > > >>> Then we can involve other peoples in the community to join the >
>> > > effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, >
>> > >>>
>> > > -Ian. > > >> > > > > >
>>
>>
>>
>> --
>> Best Regards！
>> Huxing
>>
>

Re: About the comments coverage of the code

[yuhang xiu]

Ok, huxing
I'd like take some time to do this.

Huxing Zhang  于2018年12月10日周一 下午11:43写道：

> On Mon, Dec 10, 2018 at 7:14 PM yuhang xiu  wrote:
> >
> > Hi,
> > @zhuzi  @shunyumaple
> > You are welcome to claim a new job.
> >
> > We currently have a project, but I have not yet divided it. I think we
> need
> > a discussion about how to divide tasks.
> > @huxing @beiwei Can you give some advice? I personally think that you can
> > divide by module
>
> +1 Using module looks good to me.
>
> > but the work of a module can be done by multiple people,
>
> If there is multiple contributors working on the same module, we can
> even break it down by package name.
> We can do this only when it happen.
>
> > as long as there is no conflict.
> >
> >
> >
> > 竹子  于2018年12月10日周一 下午2:34写道：
> >
> > > 我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On
> > > 12/10/2018 14:28, yuhang xiu wrote: very nice. If there is any
> progress,
> > > you can tell us here. 雷舜宇  于2018年12月10日周一
> > > 下午12:03写道： > I said that I am currently doing the service-completed
> > > comments completion > work. If there is a problem, I will exchange
> this on
> > > the mailing list. > > 田 小波  于2018年12月10日周一
> > > 上午10:03写道： > > > OK, I will submit a PR tomorrow. > > > > > 在
> > > 2018年12月9日，下午4:50，Ian Luo  写道： > > > > > > I will
> take
> > > a look, and talk to you on pull request. > > > > > > -Ian. > > > > > >
> On
> > > Fri, Dec 7, 2018 at 6:11 PM 田 小波  >
> wrote: >
> > > > > > > >> Ian: > > >> I will make some simple changes to these
> articles
> > > and submit them to > > >> dubbo-website. Limited to personal
> abilities, if
> > > there are any > mistakes > > in > > >> the article, please help to
> modify
> > > and improve. > > >> > > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给 > >
> > > dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > > >> > > >> Thanks! >
> > >>
> > > Xiaobo > > >> > > >>> Pls. go ahead to submit your articles: > > >>> >
> >
> > > >>> Then we can involve other peoples in the community to join the >
> > > effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, > >
> >>>
> > > -Ian. > > >> > > > > >
>
>
>
> --
> Best Regards！
> Huxing
>

Re: About the comments coverage of the code

[Huxing Zhang]

On Mon, Dec 10, 2018 at 7:14 PM yuhang xiu  wrote:
>
> Hi,
> @zhuzi  @shunyumaple
> You are welcome to claim a new job.
>
> We currently have a project, but I have not yet divided it. I think we need
> a discussion about how to divide tasks.
> @huxing @beiwei Can you give some advice? I personally think that you can
> divide by module

+1 Using module looks good to me.

> but the work of a module can be done by multiple people,

If there is multiple contributors working on the same module, we can
even break it down by package name.
We can do this only when it happen.

> as long as there is no conflict.
>
>
>
> 竹子  于2018年12月10日周一 下午2:34写道：
>
> > 我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On
> > 12/10/2018 14:28, yuhang xiu wrote: very nice. If there is any progress,
> > you can tell us here. 雷舜宇  于2018年12月10日周一
> > 下午12:03写道： > I said that I am currently doing the service-completed
> > comments completion > work. If there is a problem, I will exchange this on
> > the mailing list. > > 田 小波  于2018年12月10日周一
> > 上午10:03写道： > > > OK, I will submit a PR tomorrow. > > > > > 在
> > 2018年12月9日，下午4:50，Ian Luo  写道： > > > > > > I will take
> > a look, and talk to you on pull request. > > > > > > -Ian. > > > > > > On
> > Fri, Dec 7, 2018 at 6:11 PM 田 小波  > wrote: >
> > > > > > >> Ian: > > >> I will make some simple changes to these articles
> > and submit them to > > >> dubbo-website. Limited to personal abilities, if
> > there are any > mistakes > > in > > >> the article, please help to modify
> > and improve. > > >> > > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给 > >
> > dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > > >> > > >> Thanks! > > >>
> > Xiaobo > > >> > > >>> Pls. go ahead to submit your articles: > > >>> > >
> > >>> Then we can involve other peoples in the community to join the >
> > effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, > > >>>
> > -Ian. > > >> > > > > >



-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[yuhang xiu]

Hi,
@zhuzi  @shunyumaple
You are welcome to claim a new job.

We currently have a project, but I have not yet divided it. I think we need
a discussion about how to divide tasks.
@huxing @beiwei Can you give some advice? I personally think that you can
divide by module, but the work of a module can be done by multiple people,
as long as there is no conflict.



竹子  于2018年12月10日周一 下午2:34写道：

> 我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On
> 12/10/2018 14:28, yuhang xiu wrote: very nice. If there is any progress,
> you can tell us here. 雷舜宇  于2018年12月10日周一
> 下午12:03写道： > I said that I am currently doing the service-completed
> comments completion > work. If there is a problem, I will exchange this on
> the mailing list. > > 田 小波  于2018年12月10日周一
> 上午10:03写道： > > > OK, I will submit a PR tomorrow. > > > > > 在
> 2018年12月9日，下午4:50，Ian Luo  写道： > > > > > > I will take
> a look, and talk to you on pull request. > > > > > > -Ian. > > > > > > On
> Fri, Dec 7, 2018 at 6:11 PM 田 小波  > wrote: >
> > > > > >> Ian: > > >> I will make some simple changes to these articles
> and submit them to > > >> dubbo-website. Limited to personal abilities, if
> there are any > mistakes > > in > > >> the article, please help to modify
> and improve. > > >> > > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给 > >
> dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > > >> > > >> Thanks! > > >>
> Xiaobo > > >> > > >>> Pls. go ahead to submit your articles: > > >>> > >
> >>> Then we can involve other peoples in the community to join the >
> effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, > > >>>
> -Ian. > > >> > > > > >

Re: About the comments coverage of the code

[竹子]

我现在正在补全dubboprotocal的注释 竹子 邮箱zhuzi.w...@gmail.com 签名由 网易邮箱大师 定制 On 12/10/2018 
14:28, yuhang xiu wrote: very nice. If there is any progress, you can tell us 
here. 雷舜宇  于2018年12月10日周一 下午12:03写道： > I said that I am 
currently doing the service-completed comments completion > work. If there is a 
problem, I will exchange this on the mailing list. > > 田 小波 
 于2018年12月10日周一 上午10:03写道： > > > OK, I will submit 
a PR tomorrow. > > > > > 在 2018年12月9日，下午4:50，Ian Luo  写道： > 
> > > > > I will take a look, and talk to you on pull request. > > > > > > 
-Ian. > > > > > > On Fri, Dec 7, 2018 at 6:11 PM 田 小波 
 > wrote: > > > > > >> Ian: > > >> I will make some 
simple changes to these articles and submit them to > > >> dubbo-website. 
Limited to personal abilities, if there are any > mistakes > > in > > >> the 
article, please help to modify and improve. > > >> > > >> 
我会对这些文章做一些简单的修改，然后将这些文章提交给 > > dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。 > 
> >> > > >> Thanks! > > >> Xiaobo > > >> > > >>> Pls. go ahead to submit your 
articles: > > >>> > > >>> Then we can involve other peoples in the community to 
join the > effort. > > >>> > > >>> What do you think? > > >>> > > >>> Thanks, > 
> >>> -Ian. > > >> > > > > >

Re: About the comments coverage of the code

[yuhang xiu]

very nice.
If there is any progress, you can tell us here.

雷舜宇  于2018年12月10日周一 下午12:03写道：

> I said that I am currently doing the service-completed comments completion
> work. If there is a problem, I will exchange this on the mailing list.
>
> 田 小波  于2018年12月10日周一 上午10:03写道：
>
> > OK, I will submit a PR tomorrow.
> >
> > > 在 2018年12月9日，下午4:50，Ian Luo  写道：
> > >
> > > I will take a look, and talk to you on pull request.
> > >
> > > -Ian.
> > >
> > > On Fri, Dec 7, 2018 at 6:11 PM 田 小波 
> wrote:
> > >
> > >> Ian:
> > >> I will make some simple changes to these articles and submit them to
> > >> dubbo-website. Limited to personal abilities, if there are any
> mistakes
> > in
> > >> the article, please help to modify and improve.
> > >>
> > >> 我会对这些文章做一些简单的修改，然后将这些文章提交给
> > dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。
> > >>
> > >> Thanks!
> > >> Xiaobo
> > >>
> > >>> Pls. go ahead to submit your articles:
> > >>>
> > >>> Then we can involve other peoples in the community to join the
> effort.
> > >>>
> > >>> What do you think?
> > >>>
> > >>> Thanks,
> > >>> -Ian.
> > >>
> >
> >
>

Re: About the comments coverage of the code

[雷舜宇]

I said that I am currently doing the service-completed comments completion
work. If there is a problem, I will exchange this on the mailing list.

田 小波  于2018年12月10日周一 上午10:03写道：

> OK, I will submit a PR tomorrow.
>
> > 在 2018年12月9日，下午4:50，Ian Luo  写道：
> >
> > I will take a look, and talk to you on pull request.
> >
> > -Ian.
> >
> > On Fri, Dec 7, 2018 at 6:11 PM 田 小波  wrote:
> >
> >> Ian:
> >> I will make some simple changes to these articles and submit them to
> >> dubbo-website. Limited to personal abilities, if there are any mistakes
> in
> >> the article, please help to modify and improve.
> >>
> >> 我会对这些文章做一些简单的修改，然后将这些文章提交给
> dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。
> >>
> >> Thanks!
> >> Xiaobo
> >>
> >>> Pls. go ahead to submit your articles:
> >>>
> >>> Then we can involve other peoples in the community to join the effort.
> >>>
> >>> What do you think?
> >>>
> >>> Thanks,
> >>> -Ian.
> >>
>
>

Re: About the comments coverage of the code

[田 小波]

OK, I will submit a PR tomorrow.

> 在 2018年12月9日，下午4:50，Ian Luo  写道：
> 
> I will take a look, and talk to you on pull request.
> 
> -Ian.
> 
> On Fri, Dec 7, 2018 at 6:11 PM 田 小波  wrote:
> 
>> Ian:
>> I will make some simple changes to these articles and submit them to
>> dubbo-website. Limited to personal abilities, if there are any mistakes in
>> the article, please help to modify and improve.
>> 
>> 我会对这些文章做一些简单的修改，然后将这些文章提交给 dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。
>> 
>> Thanks!
>> Xiaobo
>> 
>>> Pls. go ahead to submit your articles:
>>> 
>>> Then we can involve other peoples in the community to join the effort.
>>> 
>>> What do you think?
>>> 
>>> Thanks,
>>> -Ian.
>> 

Re: About the comments coverage of the code

[Ian Luo]

I will take a look, and talk to you on pull request.

-Ian.

On Fri, Dec 7, 2018 at 6:11 PM 田 小波  wrote:

> Ian:
> I will make some simple changes to these articles and submit them to
> dubbo-website. Limited to personal abilities, if there are any mistakes in
> the article, please help to modify and improve.
>
> 我会对这些文章做一些简单的修改，然后将这些文章提交给 dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。
>
> Thanks!
> Xiaobo
>
> > Pls. go ahead to submit your articles:
> >
> > Then we can involve other peoples in the community to join the effort.
> >
> > What do you think?
> >
> > Thanks,
> > -Ian.
>

Re: About the comments coverage of the code

[田 小波]

Ian:
I will make some simple changes to these articles and submit them to 
dubbo-website. Limited to personal abilities, if there are any mistakes in the 
article, please help to modify and improve.

我会对这些文章做一些简单的修改，然后将这些文章提交给 dubbo-website。限于个人能力，如果文章中有错误不妥之处，还请大家帮忙修改和完善。

Thanks!
Xiaobo

> Pls. go ahead to submit your articles:
> 
> Then we can involve other peoples in the community to join the effort.
> 
> What do you think?
> 
> Thanks,
> -Ian.

Re: About the comments coverage of the code

[Ian Luo]

Xiaobo,

Pls. go ahead to submit your articles:

时间  文章
> 2018-10-01  Dubbo 源码分析 - SPI 机制<
> https://www.cnblogs.com/nuun/p/9758682.html>
> 2018-10-13  Dubbo 源码分析 - 自适应拓展原理<
> https://www.cnblogs.com/nuun/p/9788319.html>
> 2018-10-31  Dubbo 源码分析 - 服务导出<
> https://www.cnblogs.com/nuun/p/9887190.html>
> 2018-11-12  Dubbo 源码分析 - 服务引用<
> https://www.cnblogs.com/nuun/p/9950361.html>
> 2018-11-17  Dubbo 源码分析 - 集群容错之 Directory<
> https://www.cnblogs.com/nuun/p/9980247.html>
> 2018-11-20  Dubbo 源码分析 - 集群容错之 Router<
> https://www.cnblogs.com/nuun/p/9991413.html>
> 2018-11-24  Dubbo 源码分析 - 集群容错之 Cluster<
> https://www.cnblogs.com/nuun/p/10018429.html>
> 2018-11-29  Dubbo 源码分析 - 集群容错之 LoadBalance<
> https://www.cnblogs.com/nuun/p/10041964.html>
> 未完成 Dubbo 源码分析 - 并发模型
> 未完成 Dubbo 源码分析 - 编解码


Then we can involve other peoples in the community to join the effort.

What do you think?

Thanks,
-Ian.


On Fri, Dec 7, 2018 at 11:04 AM Huxing Zhang  wrote:

> On Thu, Dec 6, 2018 at 7:25 PM Ian Luo  wrote:
> >
> > That's correct.
> >
> > I think now it is a good chance to build another book 'source code guide'
> > aside of 'user manual', 'dev guide', and 'admin book'. What do you think?
>
> +1 maybe we can also organize some online webinar for Dubbo's source
> code analysis.
>
> >
> > Thanks,
> > -Ian.
> >
> >
> > On Thu, Dec 6, 2018 at 6:20 PM 田 小波  wrote:
> >
> > > Hi Ian:
> > >
> > > There is already an article[1] on the Dubbo architecture in Dubbo's
> > > official documentation. Maybe I can write an article about "how to read
> > > Dubbo code" according to my own experience.
> > >
> > > Dubbo 官方文档中已经有一篇对 Dubbo 架构介绍的文章，或许我可以根据我自己的经历写一篇如何阅读 Dubbo 源码的文章。
> > >
> > > [1] http://dubbo.apache.org/zh-cn/docs/dev/design.html
> > >
> > > 在 2018年12月6日，下午2:02，Ian Luo  写道：
> > >
> > > Xiaobo,
> > >
> > > I think this is a good proposal. Pls. create a new section 'source code
> > > guide' under docs, and let's build it together.
> > >
> > > Thanks,
> > > -Ian.
> > >
> > >
> > >
>
>
>
> --
> Best Regards！
> Huxing
>

Re: About the comments coverage of the code

[Huxing Zhang]

On Thu, Dec 6, 2018 at 7:25 PM Ian Luo  wrote:
>
> That's correct.
>
> I think now it is a good chance to build another book 'source code guide'
> aside of 'user manual', 'dev guide', and 'admin book'. What do you think?

+1 maybe we can also organize some online webinar for Dubbo's source
code analysis.

>
> Thanks,
> -Ian.
>
>
> On Thu, Dec 6, 2018 at 6:20 PM 田 小波  wrote:
>
> > Hi Ian:
> >
> > There is already an article[1] on the Dubbo architecture in Dubbo's
> > official documentation. Maybe I can write an article about "how to read
> > Dubbo code" according to my own experience.
> >
> > Dubbo 官方文档中已经有一篇对 Dubbo 架构介绍的文章，或许我可以根据我自己的经历写一篇如何阅读 Dubbo 源码的文章。
> >
> > [1] http://dubbo.apache.org/zh-cn/docs/dev/design.html
> >
> > 在 2018年12月6日，下午2:02，Ian Luo  写道：
> >
> > Xiaobo,
> >
> > I think this is a good proposal. Pls. create a new section 'source code
> > guide' under docs, and let's build it together.
> >
> > Thanks,
> > -Ian.
> >
> >
> >



-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[Ian Luo]

That's correct.

I think now it is a good chance to build another book 'source code guide'
aside of 'user manual', 'dev guide', and 'admin book'. What do you think?

Thanks,
-Ian.


On Thu, Dec 6, 2018 at 6:20 PM 田 小波  wrote:

> Hi Ian:
>
> There is already an article[1] on the Dubbo architecture in Dubbo's
> official documentation. Maybe I can write an article about "how to read
> Dubbo code" according to my own experience.
>
> Dubbo 官方文档中已经有一篇对 Dubbo 架构介绍的文章，或许我可以根据我自己的经历写一篇如何阅读 Dubbo 源码的文章。
>
> [1] http://dubbo.apache.org/zh-cn/docs/dev/design.html
>
> 在 2018年12月6日，下午2:02，Ian Luo  写道：
>
> Xiaobo,
>
> I think this is a good proposal. Pls. create a new section 'source code
> guide' under docs, and let's build it together.
>
> Thanks,
> -Ian.
>
>
>

Re: About the comments coverage of the code

[田 小波]

Hi Ian:

There is already an article[1] on the Dubbo architecture in Dubbo's official 
documentation. Maybe I can write an article about "how to read Dubbo code" 
according to my own experience.

Dubbo 官方文档中已经有一篇对 Dubbo 架构介绍的文章，或许我可以根据我自己的经历写一篇如何阅读 Dubbo 源码的文章。

[1] http://dubbo.apache.org/zh-cn/docs/dev/design.html

在 2018年12月6日，下午2:02，Ian Luo mailto:ian@gmail.com>> 写道：

Xiaobo,

I think this is a good proposal. Pls. create a new section 'source code
guide' under docs, and let's build it together.

Thanks,
-Ian.

Re: About the comments coverage of the code

[Huxing Zhang]

On Thu, Dec 6, 2018 at 2:05 PM Ian Luo  wrote:
>
> Xiaobo,
>
> Pls. convert all your articles into markdown format first, and share us
> your repository on GitHub.

I'd rather recommend to send pull request one by one. In this way, the
contribution can be measured so that the contributor can become a
committer in some day.

>
> Thanks,
> -Ian.
>
>
> On Thu, Dec 6, 2018 at 2:02 PM Ian Luo  wrote:
>
> > Xiaobo,
> >
> > I think this is a good proposal. Pls. create a new section 'source code
> > guide' under docs, and let's build it together.
> >
> > Thanks,
> > -Ian.
> >
> >
> > On Wed, Dec 5, 2018 at 8:57 PM 田 小波  wrote:
> >
> >> Hi community,
> >>
> >> I noticed that people in the WeChat group said that Dubbo's comments are
> >> too few and unfriendly to beginners. I just wrote some source analysis
> >> articles about Dubbo in the past. I have a lot of comments and analysis on
> >> the Dubbo source in the article. I think these articles can help beginners
> >> learn Dubbo. The list of articles is as follows:
> >>
> >> 时间  文章
> >> 2018-10-01  Dubbo 源码分析 - SPI 机制<
> >> https://www.cnblogs.com/nuun/p/9758682.html>
> >> 2018-10-13  Dubbo 源码分析 - 自适应拓展原理<
> >> https://www.cnblogs.com/nuun/p/9788319.html>
> >> 2018-10-31  Dubbo 源码分析 - 服务导出<
> >> https://www.cnblogs.com/nuun/p/9887190.html>
> >> 2018-11-12  Dubbo 源码分析 - 服务引用<
> >> https://www.cnblogs.com/nuun/p/9950361.html>
> >> 2018-11-17  Dubbo 源码分析 - 集群容错之 Directory<
> >> https://www.cnblogs.com/nuun/p/9980247.html>
> >> 2018-11-20  Dubbo 源码分析 - 集群容错之 Router<
> >> https://www.cnblogs.com/nuun/p/9991413.html>
> >> 2018-11-24  Dubbo 源码分析 - 集群容错之 Cluster<
> >> https://www.cnblogs.com/nuun/p/10018429.html>
> >> 2018-11-29  Dubbo 源码分析 - 集群容错之 LoadBalance<
> >> https://www.cnblogs.com/nuun/p/10041964.html>
> >> 未完成 Dubbo 源码分析 - 并发模型
> >> 未完成 Dubbo 源码分析 - 编解码
> >>
> >> If you are interested, you can review it. If you feel good, I can submit
> >> these articles to dubbo-website. If you feel that writing is not good, you
> >> are welcome to give some advice.
> >>
> >> 我注意到有人在微信群里说 Dubbo 的注释太少，对初学者不友好。我正好在过去一段时间内写了一些关于 Dubbo 的源码分析文章，我在文章中对
> >> Dubbo 源码进行了大量的注释和分析，我觉得这些文章可以帮助初学者学习 Dubbo。大家如果有兴趣，可以进行
> >> review。如果觉得还不错，我可以将这些文章提交给 dubbo-website。如果觉得写的不好，也欢迎多多指教。
> >>
> >> Regards
> >> Xiaobo
> >>
> >> 在 2018年12月5日，下午1:56，Ian Luo  写道：
> >>
> >> What I suggest is to revisit and enhance the existing javadoc/comments
> >> before consider to add more:
> >> 1. Enhance JavaDoc for all API. For this part, we may need some helps from
> >> native speakers
> >> 2. Revisit the current existing comments, and make it easier to understand
> >>
> >> Just my two cents,
> >> -Ian.
> >>
> >> On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
> >>
> >> Recently dubbo held an offline meetup. When discussing with many
> >> participants, many people have suggested that dubbo has very few comments.
> >>
> >> Comments are very important for us to understand the code. If our comments
> >> are few, it is very unfriendly for new developers.
> >>
> >> I created a new issue[1] to track this. We need more developers to
> >> contribute notes. I will continue to follow up on this matter.
> >>
> >> [1] https://github.com/apache/incubator-dubbo/issues/2884
> >>
> >>
> >>



-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[Ian Luo]

Xiaobo,

Pls. convert all your articles into markdown format first, and share us
your repository on GitHub.

Thanks,
-Ian.


On Thu, Dec 6, 2018 at 2:02 PM Ian Luo  wrote:

> Xiaobo,
>
> I think this is a good proposal. Pls. create a new section 'source code
> guide' under docs, and let's build it together.
>
> Thanks,
> -Ian.
>
>
> On Wed, Dec 5, 2018 at 8:57 PM 田 小波  wrote:
>
>> Hi community,
>>
>> I noticed that people in the WeChat group said that Dubbo's comments are
>> too few and unfriendly to beginners. I just wrote some source analysis
>> articles about Dubbo in the past. I have a lot of comments and analysis on
>> the Dubbo source in the article. I think these articles can help beginners
>> learn Dubbo. The list of articles is as follows:
>>
>> 时间  文章
>> 2018-10-01  Dubbo 源码分析 - SPI 机制<
>> https://www.cnblogs.com/nuun/p/9758682.html>
>> 2018-10-13  Dubbo 源码分析 - 自适应拓展原理<
>> https://www.cnblogs.com/nuun/p/9788319.html>
>> 2018-10-31  Dubbo 源码分析 - 服务导出<
>> https://www.cnblogs.com/nuun/p/9887190.html>
>> 2018-11-12  Dubbo 源码分析 - 服务引用<
>> https://www.cnblogs.com/nuun/p/9950361.html>
>> 2018-11-17  Dubbo 源码分析 - 集群容错之 Directory<
>> https://www.cnblogs.com/nuun/p/9980247.html>
>> 2018-11-20  Dubbo 源码分析 - 集群容错之 Router<
>> https://www.cnblogs.com/nuun/p/9991413.html>
>> 2018-11-24  Dubbo 源码分析 - 集群容错之 Cluster<
>> https://www.cnblogs.com/nuun/p/10018429.html>
>> 2018-11-29  Dubbo 源码分析 - 集群容错之 LoadBalance<
>> https://www.cnblogs.com/nuun/p/10041964.html>
>> 未完成 Dubbo 源码分析 - 并发模型
>> 未完成 Dubbo 源码分析 - 编解码
>>
>> If you are interested, you can review it. If you feel good, I can submit
>> these articles to dubbo-website. If you feel that writing is not good, you
>> are welcome to give some advice.
>>
>> 我注意到有人在微信群里说 Dubbo 的注释太少，对初学者不友好。我正好在过去一段时间内写了一些关于 Dubbo 的源码分析文章，我在文章中对
>> Dubbo 源码进行了大量的注释和分析，我觉得这些文章可以帮助初学者学习 Dubbo。大家如果有兴趣，可以进行
>> review。如果觉得还不错，我可以将这些文章提交给 dubbo-website。如果觉得写的不好，也欢迎多多指教。
>>
>> Regards
>> Xiaobo
>>
>> 在 2018年12月5日，下午1:56，Ian Luo  写道：
>>
>> What I suggest is to revisit and enhance the existing javadoc/comments
>> before consider to add more:
>> 1. Enhance JavaDoc for all API. For this part, we may need some helps from
>> native speakers
>> 2. Revisit the current existing comments, and make it easier to understand
>>
>> Just my two cents,
>> -Ian.
>>
>> On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
>>
>> Recently dubbo held an offline meetup. When discussing with many
>> participants, many people have suggested that dubbo has very few comments.
>>
>> Comments are very important for us to understand the code. If our comments
>> are few, it is very unfriendly for new developers.
>>
>> I created a new issue[1] to track this. We need more developers to
>> contribute notes. I will continue to follow up on this matter.
>>
>> [1] https://github.com/apache/incubator-dubbo/issues/2884
>>
>>
>>

Re: About the comments coverage of the code

[Ian Luo]

Xiaobo,

I think this is a good proposal. Pls. create a new section 'source code
guide' under docs, and let's build it together.

Thanks,
-Ian.


On Wed, Dec 5, 2018 at 8:57 PM 田 小波  wrote:

> Hi community,
>
> I noticed that people in the WeChat group said that Dubbo's comments are
> too few and unfriendly to beginners. I just wrote some source analysis
> articles about Dubbo in the past. I have a lot of comments and analysis on
> the Dubbo source in the article. I think these articles can help beginners
> learn Dubbo. The list of articles is as follows:
>
> 时间  文章
> 2018-10-01  Dubbo 源码分析 - SPI 机制<
> https://www.cnblogs.com/nuun/p/9758682.html>
> 2018-10-13  Dubbo 源码分析 - 自适应拓展原理<
> https://www.cnblogs.com/nuun/p/9788319.html>
> 2018-10-31  Dubbo 源码分析 - 服务导出<
> https://www.cnblogs.com/nuun/p/9887190.html>
> 2018-11-12  Dubbo 源码分析 - 服务引用<
> https://www.cnblogs.com/nuun/p/9950361.html>
> 2018-11-17  Dubbo 源码分析 - 集群容错之 Directory<
> https://www.cnblogs.com/nuun/p/9980247.html>
> 2018-11-20  Dubbo 源码分析 - 集群容错之 Router<
> https://www.cnblogs.com/nuun/p/9991413.html>
> 2018-11-24  Dubbo 源码分析 - 集群容错之 Cluster<
> https://www.cnblogs.com/nuun/p/10018429.html>
> 2018-11-29  Dubbo 源码分析 - 集群容错之 LoadBalance<
> https://www.cnblogs.com/nuun/p/10041964.html>
> 未完成 Dubbo 源码分析 - 并发模型
> 未完成 Dubbo 源码分析 - 编解码
>
> If you are interested, you can review it. If you feel good, I can submit
> these articles to dubbo-website. If you feel that writing is not good, you
> are welcome to give some advice.
>
> 我注意到有人在微信群里说 Dubbo 的注释太少，对初学者不友好。我正好在过去一段时间内写了一些关于 Dubbo 的源码分析文章，我在文章中对
> Dubbo 源码进行了大量的注释和分析，我觉得这些文章可以帮助初学者学习 Dubbo。大家如果有兴趣，可以进行
> review。如果觉得还不错，我可以将这些文章提交给 dubbo-website。如果觉得写的不好，也欢迎多多指教。
>
> Regards
> Xiaobo
>
> 在 2018年12月5日，下午1:56，Ian Luo  写道：
>
> What I suggest is to revisit and enhance the existing javadoc/comments
> before consider to add more:
> 1. Enhance JavaDoc for all API. For this part, we may need some helps from
> native speakers
> 2. Revisit the current existing comments, and make it easier to understand
>
> Just my two cents,
> -Ian.
>
> On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
>
> Recently dubbo held an offline meetup. When discussing with many
> participants, many people have suggested that dubbo has very few comments.
>
> Comments are very important for us to understand the code. If our comments
> are few, it is very unfriendly for new developers.
>
> I created a new issue[1] to track this. We need more developers to
> contribute notes. I will continue to follow up on this matter.
>
> [1] https://github.com/apache/incubator-dubbo/issues/2884
>
>
>

Re: About the comments coverage of the code

[Huxing Zhang]

On Wed, Dec 5, 2018 at 8:57 PM 田 小波  wrote:
>
> Hi community,
>
> I noticed that people in the WeChat group said that Dubbo's comments are too 
> few and unfriendly to beginners. I just wrote some source analysis articles 
> about Dubbo in the past. I have a lot of comments and analysis on the Dubbo 
> source in the article. I think these articles can help beginners learn Dubbo. 
> The list of articles is as follows:

Would you please add your comments into Dubbo's source code by sending
pull request?
This can help more people to understand.

>
> 时间  文章
> 2018-10-01  Dubbo 源码分析 - SPI 
> 机制
> 2018-10-13  Dubbo 源码分析 - 
> 自适应拓展原理
> 2018-10-31  Dubbo 源码分析 - 
> 服务导出
> 2018-11-12  Dubbo 源码分析 - 
> 服务引用
> 2018-11-17  Dubbo 源码分析 - 集群容错之 
> Directory
> 2018-11-20  Dubbo 源码分析 - 集群容错之 
> Router
> 2018-11-24  Dubbo 源码分析 - 集群容错之 
> Cluster
> 2018-11-29  Dubbo 源码分析 - 集群容错之 
> LoadBalance
> 未完成 Dubbo 源码分析 - 并发模型
> 未完成 Dubbo 源码分析 - 编解码
>
> If you are interested, you can review it. If you feel good, I can submit 
> these articles to dubbo-website. If you feel that writing is not good, you 
> are welcome to give some advice.

Any contribution is welcome, if you could put your articles to Dubbo
website as serial of blog posts, that would be really nice. Or you can
enhance the current documentation with your article.


>
> 我注意到有人在微信群里说 Dubbo 的注释太少，对初学者不友好。我正好在过去一段时间内写了一些关于 Dubbo 的源码分析文章，我在文章中对 Dubbo 
> 源码进行了大量的注释和分析，我觉得这些文章可以帮助初学者学习 Dubbo。大家如果有兴趣，可以进行 review。如果觉得还不错，我可以将这些文章提交给 
> dubbo-website。如果觉得写的不好，也欢迎多多指教。
>
> Regards
> Xiaobo
>
> 在 2018年12月5日，下午1:56，Ian Luo  写道：
>
> What I suggest is to revisit and enhance the existing javadoc/comments
> before consider to add more:
> 1. Enhance JavaDoc for all API. For this part, we may need some helps from
> native speakers
> 2. Revisit the current existing comments, and make it easier to understand
>
> Just my two cents,
> -Ian.
>
> On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
>
> Recently dubbo held an offline meetup. When discussing with many
> participants, many people have suggested that dubbo has very few comments.
>
> Comments are very important for us to understand the code. If our comments
> are few, it is very unfriendly for new developers.
>
> I created a new issue[1] to track this. We need more developers to
> contribute notes. I will continue to follow up on this matter.
>
> [1] https://github.com/apache/incubator-dubbo/issues/2884
>
>


-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[田 小波]

Hi community,

I noticed that people in the WeChat group said that Dubbo's comments are too 
few and unfriendly to beginners. I just wrote some source analysis articles 
about Dubbo in the past. I have a lot of comments and analysis on the Dubbo 
source in the article. I think these articles can help beginners learn Dubbo. 
The list of articles is as follows:

时间  文章
2018-10-01  Dubbo 源码分析 - SPI 
机制
2018-10-13  Dubbo 源码分析 - 
自适应拓展原理
2018-10-31  Dubbo 源码分析 - 
服务导出
2018-11-12  Dubbo 源码分析 - 
服务引用
2018-11-17  Dubbo 源码分析 - 集群容错之 
Directory
2018-11-20  Dubbo 源码分析 - 集群容错之 
Router
2018-11-24  Dubbo 源码分析 - 集群容错之 
Cluster
2018-11-29  Dubbo 源码分析 - 集群容错之 
LoadBalance
未完成 Dubbo 源码分析 - 并发模型
未完成 Dubbo 源码分析 - 编解码

If you are interested, you can review it. If you feel good, I can submit these 
articles to dubbo-website. If you feel that writing is not good, you are 
welcome to give some advice.

我注意到有人在微信群里说 Dubbo 的注释太少，对初学者不友好。我正好在过去一段时间内写了一些关于 Dubbo 的源码分析文章，我在文章中对 Dubbo 
源码进行了大量的注释和分析，我觉得这些文章可以帮助初学者学习 Dubbo。大家如果有兴趣，可以进行 review。如果觉得还不错，我可以将这些文章提交给 
dubbo-website。如果觉得写的不好，也欢迎多多指教。

Regards
Xiaobo

在 2018年12月5日，下午1:56，Ian Luo  写道：

What I suggest is to revisit and enhance the existing javadoc/comments
before consider to add more:
1. Enhance JavaDoc for all API. For this part, we may need some helps from
native speakers
2. Revisit the current existing comments, and make it easier to understand

Just my two cents,
-Ian.

On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:

Recently dubbo held an offline meetup. When discussing with many
participants, many people have suggested that dubbo has very few comments.

Comments are very important for us to understand the code. If our comments
are few, it is very unfriendly for new developers.

I created a new issue[1] to track this. We need more developers to
contribute notes. I will continue to follow up on this matter.

[1] https://github.com/apache/incubator-dubbo/issues/2884

Re: About the comments coverage of the code

[Ian Luo]

What I suggest is to revisit and enhance the existing javadoc/comments
before consider to add more:
1. Enhance JavaDoc for all API. For this part, we may need some helps from
native speakers
2. Revisit the current existing comments, and make it easier to understand

Just my two cents,
-Ian.

On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:

> Recently dubbo held an offline meetup. When discussing with many
> participants, many people have suggested that dubbo has very few comments.
>
> Comments are very important for us to understand the code. If our comments
> are few, it is very unfriendly for new developers.
>
> I created a new issue[1] to track this. We need more developers to
> contribute notes. I will continue to follow up on this matter.
>
> [1] https://github.com/apache/incubator-dubbo/issues/2884
>

Re: About the comments coverage of the code

[Huxing Zhang]

Hi,

On Wed, Dec 5, 2018 at 10:32 AM yuhang xiu  wrote:
>
> Agree with u,
>
> I am willing to try to split them.
> The split level has not been determined yet, we need some discussion.

Do you have some suggestions?

>
> Huxing Zhang  于2018年12月4日周二 下午9:50写道：
>
> > Agree.
> >
> > I saw someone from India who would like to contribute in this issue.
> > We need to break them down to small tasks.
> >
> > Maybe separate them by modules or something smaller and manage them by
> > Github Project?
> >
> > On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
> > >
> > > Recently dubbo held an offline meetup. When discussing with many
> > > participants, many people have suggested that dubbo has very few
> > comments.
> > >
> > > Comments are very important for us to understand the code. If our
> > comments
> > > are few, it is very unfriendly for new developers.
> > >
> > > I created a new issue[1] to track this. We need more developers to
> > > contribute notes. I will continue to follow up on this matter.
> > >
> > > [1] https://github.com/apache/incubator-dubbo/issues/2884
> >
> >
> >
> > --
> > Best Regards！
> > Huxing
> >



-- 
Best Regards！
Huxing

Re: About the comments coverage of the code

[yuhang xiu]

Agree with u,

I am willing to try to split them.
The split level has not been determined yet, we need some discussion.

Huxing Zhang  于2018年12月4日周二 下午9:50写道：

> Agree.
>
> I saw someone from India who would like to contribute in this issue.
> We need to break them down to small tasks.
>
> Maybe separate them by modules or something smaller and manage them by
> Github Project?
>
> On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
> >
> > Recently dubbo held an offline meetup. When discussing with many
> > participants, many people have suggested that dubbo has very few
> comments.
> >
> > Comments are very important for us to understand the code. If our
> comments
> > are few, it is very unfriendly for new developers.
> >
> > I created a new issue[1] to track this. We need more developers to
> > contribute notes. I will continue to follow up on this matter.
> >
> > [1] https://github.com/apache/incubator-dubbo/issues/2884
>
>
>
> --
> Best Regards！
> Huxing
>

Re: About the comments coverage of the code

[Huxing Zhang]

Agree.

I saw someone from India who would like to contribute in this issue.
We need to break them down to small tasks.

Maybe separate them by modules or something smaller and manage them by
Github Project?

On Tue, Dec 4, 2018 at 5:10 PM yuhang xiu  wrote:
>
> Recently dubbo held an offline meetup. When discussing with many
> participants, many people have suggested that dubbo has very few comments.
>
> Comments are very important for us to understand the code. If our comments
> are few, it is very unfriendly for new developers.
>
> I created a new issue[1] to track this. We need more developers to
> contribute notes. I will continue to follow up on this matter.
>
> [1] https://github.com/apache/incubator-dubbo/issues/2884



-- 
Best Regards！
Huxing