add comment to exported function/method/interface/variable

[tianjipeng]

What would you like to be added: Add comment to exported function/method/interface/variable.

Why is this needed: There are many exported function/method/interface/variable that have no comment, it would be helpful if have comment.

[seeflood]

Thanks for your feedback! Lack of comments makes developers' experience very bad :< We will assign different tasks and ask the developers to add comments to their code. By the way,which part of code currently annoys you the most? We can add comments to that part first

[seeflood]

Considering that the workload of adding comments to all the modules is relatively large, we can split it into multiple tasks:

• [x] add comments to RPC related code. See #230
• [x] add comments to pubsub related code. https://github.com/mosn/layotto/pull/405
• [x] add comments to lock related code. assigned to @LXPWing
• [x] add comments to state API related code. assigned to @2019030007547
• [x] add comments to actuator related code . assigned to @Holdonbei
• [ ] add comments to tcpdump related code
• [x] add comments to WASM related code . assigned to @LXPWing
• [ ] add comments to flow-control related code
• [x] add comments to configuration API related code

[wudi-666272]

hi，Can you leave this task “add comments to RPC related code” to me to complete

[seeflood]

hi，Can you leave this task “add comments to RPC related code” to me to complete

Cool! Already assigned.Welcome to the Layotto Community and feel free to ask for help when u encounter problems.

[LXPWing]

Hi,I want to try the task 'add comments to lock related code'

[seeflood]

@LXPWing Thanks for your passion!
I modified the tasks list above and the task 'add comments to lock related code' has been assigned to u. Sorry to reply so late,I was 7*24 oncall this week and too busy to check the github notification :(

[LXPWing]

Recently learning WASM , I want to try the task 'add comments to WASM related code'

[seeflood]

Recently learning WASM , I want to try the task 'add comments to WASM related code'

Cool ! assigned to u

[Xunzhuo]

/good-first-issue cancel /help-wanted cancel

[Holdonbei]

您的邮件我已收到。

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity in the last 30 days. It will be closed in the next 7 days unless it is tagged (pinned, good first issue or help wanted) or other activity occurs. Thank you for your contributions.

[github-actions[bot]]

This issue has been automatically closed because it has not had activity in the last 37 days. If this issue is still valid, please ping a maintainer and ask them to label it as pinned, good first issue or help wanted. Thank you for your contributions.