-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[lwp]add comments for lwp system calls. #9934
base: master
Are you sure you want to change the base?
Conversation
这个 PR 的工作属于 #9263 跟踪的问题的一部分 此外,欢迎关注 |
这个comment要不要统一放到.h中? |
我建议对函数的 comment 跟着函数体走,而不是放在头文件中。好处是头文件中列出函数可以比较紧凑,方便一眼就看出所有的 API。如果夹杂了comment,导致头文件内容很长,反而不容易快速了解模块暴露的 API 列表。 参考其他软件,譬如 linux 也是推荐将函数的说明放在 .c 中 |
个人也是建议放在C文件中,component中其它组件的注释也都是放在c文件中的,因此这样可以保持整体的风格一致。 |
components/lwp/lwp_syscall.c
Outdated
@@ -329,7 +329,7 @@ static void _crt_thread_entry(void *parameter) | |||
tid = rt_thread_self(); | |||
|
|||
user_stack = (rt_size_t)tid->user_stack + tid->user_stack_size; | |||
user_stack &= ~7; //align 8 | |||
user_stack &= ~7; /*align 8*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/**/
类型的注释,还请使用/*
后留空格,*/
前保留空格的方式。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个好像是formatting工具改的,我改一下吧。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/**/
类型的注释,还请使用/*
后留空格,*/
前保留空格的方式。
已修改。
拉取/合并请求描述:(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):
代码质量 Code Quality:
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0
代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up