Add comments for common directory #530
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## develop #530 +/- ##
===========================================
- Coverage 66.56% 66.43% -0.14%
===========================================
Files 184 184
Lines 9706 9706
===========================================
- Hits 6461 6448 -13
- Misses 2604 2616 +12
- Partials 641 642 +1
Continue to review full report at Codecov.
|
AlexStocks
requested review from
zouyx,
AlexStocks and
fangyincheng
and removed request for
zouyx and
AlexStocks
AlexStocks
reviewed
May 21, 2020
common/config/environment.go
Outdated
| @@ -46,15 +46,15 @@ var ( | |||
| once sync.Once | |||
| ) | |||
|
|
|||
| // GetEnvInstance ... | |||
| // GetEnvInstance get env instance by singleton | |||
There was a problem hiding this comment.
get -> gets? and the following errors should be fixed too.
There was a problem hiding this comment.
so, find should be finds, update should be updates and so no
zouyx
reviewed
May 22, 2020
common/config/environment.go
Outdated
Comment on lines
84
to
85
| // List represents a doubly linked list. | ||
| // Configuration put externalConfigMap and appExternalConfigMap into list |
There was a problem hiding this comment.
Suggested change
| // List represents a doubly linked list. | |
| // Configuration put externalConfigMap and appExternalConfigMap into list | |
| // Configuration puts externalConfigMap and appExternalConfigMap into list | |
| // List represents a doubly linked list. |
common/extension/configurator.go
Outdated
| @@ -61,7 +61,7 @@ func GetDefaultConfigurator(url *common.URL) config_center.Configurator { | |||
|
|
|||
| } | |||
|
|
|||
| // GetDefaultConfiguratorFunc ... | |||
| // GetDefaultConfiguratorFunc default configurator function | |||
There was a problem hiding this comment.
Suggested change
| // GetDefaultConfiguratorFunc default configurator function | |
| // GetDefaultConfiguratorFunc gets default configurator function |
common/logger/logger.go
Outdated
| @@ -145,13 +145,13 @@ func SetLoggerLevel(level string) bool { | |||
| return false | |||
| } | |||
|
|
|||
| // OpsLogger ... | |||
| // OpsLogger used by the SetLoggerLevel | |||
common/logger/logger.go
Outdated
| type OpsLogger interface { | ||
| Logger | ||
| SetLoggerLevel(level string) | ||
| } | ||
|
|
||
| // SetLoggerLevel ... | ||
| // SetLoggerLevel used to set logger level |
common/node.go
Outdated
| @@ -17,7 +17,7 @@ | |||
|
|
|||
| package common | |||
|
|
|||
| // Node ... | |||
| // Node is used to process dubbo node | |||
common/url.go
Outdated
| @@ -86,7 +86,7 @@ type baseUrl struct { | |||
| PrimitiveURL string | |||
| } | |||
|
|
|||
| // URL ... | |||
| // URL is used to locate resourse to transfer data between nodes | |||
common/url.go
Outdated
| @@ -452,7 +454,7 @@ func (c URL) GetRawParam(key string) string { | |||
| } | |||
| } | |||
|
|
|||
| // GetParamBool ... | |||
| // GetParamBool is used to judge whether key exists or not | |||
common/url.go
Outdated
| @@ -432,7 +434,7 @@ func (c URL) GetParamAndDecoded(key string) (string, error) { | |||
| return value, err | |||
| } | |||
|
|
|||
| // GetRawParam ... | |||
| // GetRawParam is used to get raw param | |||
AlexStocks
approved these changes
May 22, 2020
|
please resolve conflicts |
AlexStocks
reviewed
May 23, 2020
common/config/environment.go
Outdated
| @@ -90,17 +91,17 @@ func (env *Environment) Configuration() *list.List { | |||
| return cfgList | |||
| } | |||
|
|
|||
| // SetDynamicConfiguration ... | |||
| // SetDynamicConfiguration is used to set value for dynamicConfiguration | |||
There was a problem hiding this comment.
SetDynamicConfiguration sets value for dynamicConfiguration
common/config/environment.go
Outdated
| @@ -109,7 +110,7 @@ func newInmemoryConfiguration(p *sync.Map) *InmemoryConfiguration { | |||
| return &InmemoryConfiguration{store: p} | |||
| } | |||
|
|
|||
| // GetProperty ... | |||
| // GetProperty is used the key to get value from InmemoryConfiguration instance | |||
There was a problem hiding this comment.
GetProperty gets value from InmemoryConfiguration instance by @key
zouyx
approved these changes
May 24, 2020
common/extension/config_reader.go
Outdated
| func GetConfigReaders(name string) interfaces.ConfigReader { | ||
| if configReaders[name] == nil { | ||
| panic("config reader for " + name + " is not existing, make sure you have imported the package.") | ||
| } | ||
| return configReaders[name]() | ||
| } | ||
|
|
||
| // SetDefaultConfigReader set {name} to default config reader for {module} | ||
| // SetDefaultConfigReader sets {name} to default config reader for {module} |
There was a problem hiding this comment.
what's the different {name} and @name ?
AlexStocks
approved these changes
May 24, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does:
Add comments
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: