RT-Thread的代码吐槽

发布于 2020-01-09 18:16:04 浏览：2017 订阅该版

9 个回答

hichard 认证专家 2020-01-09

这家伙很懒，什么也没写！

梦中尘 2020-01-09

这家伙很懒，什么也没写！

梦中尘 2020-01-09

这家伙很懒，什么也没写！

bernard 2020-01-10

这家伙很懒，什么也没写！

hichard 认证专家 2020-01-10

这家伙很懒，什么也没写！

梦中尘 2020-01-10

这家伙很懒，什么也没写！

>谢谢，一些参数说明相关的注释，后面完善起来。代码相关的注释，还请多列举些，特别是类似这样的：
>
>1. 哪 ...

---

我感觉你可以看一看ucosIII的内核函数的函数头注释，真实良心之作
/*
************************************************************************************************************************
*                                                  CREATE A SEMAPHORE
*
* Description: This function creates a semaphore.
*
* Arguments  : p_sem         is a pointer to the semaphore to initialize.  Your application is responsible for
*                            allocating storage for the semaphore.
*
*              p_name        is a pointer to the name you would like to give the semaphore.
*
*              cnt           is the initial value for the semaphore.
*                            If used to share resources, you should initialize to the number of resources available.
*                            If used to signal the occurrence of event(s) then you should initialize to 0.
*
*              p_err         is a pointer to a variable that will contain an error code returned by this function.
*
*                                OS_ERR_NONE                    if the call was successful
*                                OS_ERR_CREATE_ISR              if you called this function from an ISR
*                                OS_ERR_ILLEGAL_CREATE_RUN_TIME if you are trying to create the semaphore after you
*                                                                 called OSSafetyCriticalStart().
*                                OS_ERR_NAME                    if 'p_name' is a NULL pointer
*                                OS_ERR_OBJ_CREATED             if the semaphore has already been created
*                                OS_ERR_OBJ_PTR_NULL            if 'p_sem'  is a NULL pointer
*                                OS_ERR_OBJ_TYPE                if 'p_sem' has already been initialized to a different
*                                                               object type
*
* Returns    : none
************************************************************************************************************************
*/

void  OSSemCreate (OS_SEM      *p_sem,
                   CPU_CHAR    *p_name,
                   OS_SEM_CTR   cnt,
                   OS_ERR      *p_err)
这是一个ucosIII的信号量创造函数 这个函数头注释太清晰了 我根本不用看官方文档就知道这个函数怎么用，函数的功能写的非常详细，函数参数的取值以及其含义解释的非常清楚。函数的返回值种类和含义解释非常到位。感觉RT-thread官方要下点功夫了，我看RT-thread有些文件就写了一些函数实现 什么都没有注释，例如components.c这个文件的函数头基本没有注释。虽然RT-thread系统的启动方式比较新颖，然而启动部分的代码基本上没有什么说明，让人看了一头雾水，ucosIII的内核函数的内部注释也是非常到位的，如果你细细阅读ucosIII的源码，感觉注释做的真的到位。我在这里说明一下，我不是有意说rt-thread的不好，真实心希望rt-thread未来能够承担中国物联网的国产龙头RTOS，甚至走向世界与freeRTOS和ucos一较高下，真心祝愿未来国产RTOS越来越好。本来打算研究生毕业后找一个RTOS的公司工作。没办法对于我这种农村来的孩子，家庭负担多，挣钱就变得重要了，需要一个高的平台。就选择留在西安进入华为了。真实希望未来能为国产RTOS做点贡献。我一直都在学习RT-thread的，如果那里不好我就提出来的，我学了freeRTOS和ucosII和ucosIII源码 感觉还是不错的，希望能把RT-thread的源码看完。未来进入华为估计还要掌握华为liteos了。看来自己以后要和RTOS打交道一生了。真的非常喜欢RTOS这个领域。

梦中尘 2020-01-10

这家伙很懒，什么也没写！

>谢谢，一些参数说明相关的注释，后面完善起来。代码相关的注释，还请多列举些，特别是类似这样的：
>
>1. 哪 ...

---

RT-thread官方注释
/**
 * This function will initialize a semaphore and put it under control of
 * resource management.
 *
 * @param sem the semaphore object
 * @param name the name of semaphore
 * @param value the init value of semaphore
 * @param flag the flag of semaphore
 *
 * @return the operation status, RT_EOK on successful
 */
自己想要的注释
/**
 * This function will initialize a semaphore and put it under control of
 * resource management.If the user wants to use this function, 
 * you need to define a global variable of type rt_semaphore
 * This is a static way to create a semaphore
 *
 * @param sem    the semaphore object
 *
 * @param name  the name of semaphore
 *
 * @param value  the init value of semaphore
 *
 * @param flag    the flag of semaphore
 *              RT_IPC_FLAG_FIFO  Processed on a first-in, first-out basis.
 *              RT_IPC_FLAG_PRIO  Process by thread priority, that is, which thread has the highest priority, 
 *                                which operates first.
 *
 * @return       the operation status, RT_EOK on successful
 */
rt_err_t rt_sem_init(rt_sem_t    sem,
                     const char *name,
                     rt_uint32_t value,
                     rt_uint8_t  flag)
可能文本的复制过来就乱了格式，可能这个修改的比较少，我感觉能做到只看函数的头就可以理解怎么使用这个函数，STM32的官方固件库也是把参数的所有可能列出来了并说明了。感觉这样就不需要官方文档说明就可以知道这个函数怎么用。其他还有好多地方连个注释都没有。希望RT-thread官方重视起来。