[lwp]add comments for lwp system calls.

[GorrayLi]

拉取/合并请求描述：(PR description)

[

为什么提交这份PR (why to submit this PR)

add comments for lwp system calls.

你的解决方案是什么 (what is your solution)

add comments for lwp system calls.

请提供验证的bsp和config (provide the config and bsp)

• BSP:

• .config:

• action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

• 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
• 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

• 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
• 代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
• 没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
• 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
• 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
• 代码是高质量的 Code in this PR is of high quality
• 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
• 如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

[unicornx]

这个 PR 的工作属于 #9263 跟踪的问题的一部分

此外，欢迎关注

• [Feature] RTT doxygen 文档改进 #9824 计划

[supperthomas]

这个comment要不要统一放到.h中？

[unicornx]

这个comment要不要统一放到.h中？

我建议对函数的 comment 跟着函数体走，而不是放在头文件中。好处是头文件中列出函数可以比较紧凑，方便一眼就看出所有的 API。如果夹杂了comment，导致头文件内容很长，反而不容易快速了解模块暴露的 API 列表。

参考其他软件，譬如 linux 也是推荐将函数的说明放在 .c 中

[GorrayLi]

这个comment要不要统一放到.h中？

我建议对函数的 comment 跟着函数体走，而不是放在头文件中。好处是头文件中列出函数可以比较紧凑，方便一眼就看出所有的 API。如果夹杂了comment，导致头文件内容很长，反而不容易快速了解模块暴露的 API 列表。

参考其他软件，譬如 linux 也是推荐将函数的说明放在 .c 中

个人也是建议放在C文件中，component中其它组件的注释也都是放在c文件中的，因此这样可以保持整体的风格一致。

[unicornx]

Hi，ALL。后面大家做 doxygen 部分工作时，请关注一下 #9824 这个 issue，我们用这个 issue 来统一规划和同步相关工作，譬如哪些重要哪些可以先做等等。我的建议是如果您以后在提相关 pr 前可以先看一下 9824，或者提交一个 issue 将你想要解决的问题发出来，确定和整体规划不要有冲突后再进行。我现在自愿 lead 并维护 doxygen 相关工作，任何相关疑问可以找我沟通（群内或者 github 9824 上）。