Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code comment and document refinement #54

Closed
chunericli opened this issue Aug 9, 2018 · 1 comment
Closed

Code comment and document refinement #54

chunericli opened this issue Aug 9, 2018 · 1 comment
Labels
area/document Category issues or prs related to document.

Comments

@chunericli
Copy link

Issue Description

注释编写语言集中,中英文混合看的别扭,sentinel-core中的eagleeye没任何注释,理解费劲
Type: bug report or feature request
feature request

Describe what happened (or what feature you want)

每个类加点注释说明

Describe what you expected to happen

每个单独的java类注释规范统一下,最好是全英文或者全中文,很多带有感叹号的能处理下最好了,看着别扭

How to reproduce it (as minimally and precisely as possible)

  1. WarmUpController的coolDownTokens方法
  2. ***Exception都存在感叹号
  3. eagleeye中实现都没注释

Tell us your environment

JDK8+Windows

Anything else we need to know?

1.文档和Roadmap中的描述如果能更详细点,更有利于帮助参与建设

@sczyh30 sczyh30 changed the title 注释相关事宜 Code comment and document refinement Aug 10, 2018
@sczyh30
Copy link
Member

sczyh30 commented Aug 10, 2018

Hi, thanks for your suggestion. We'll refine the code comments continuously.

For roadmap, this is only a blueprint. Some of the details should be well discussed. You are welcomed to provide thoughts and advice to make our community better :)

@sczyh30 sczyh30 added the area/document Category issues or prs related to document. label Aug 10, 2018
@sczyh30 sczyh30 closed this as completed Nov 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/document Category issues or prs related to document.
Projects
None yet
Development

No branches or pull requests

2 participants