> 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日周四
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
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
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
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注入,很多隐似的依赖注入,加上注释是不是跟有利于源码学习,你们是怎么人为的呢?
竹子
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
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
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
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
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
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
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
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
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
我现在正在补全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
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
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
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
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
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.
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 源码分析 - 服务导出<
>
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
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
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]
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
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
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
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
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
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
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
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
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
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
34 matches
Mail list logo
