精华内容
下载资源
问答
  • 注释规范

    2020-06-03 23:26:00
    注释规范要求 下面以C++中的头文件为例来说明如何进行注释,以及注释要求。 注意:由于blog显示原因,把其中的pre1改为pre,把b1改为b,删掉[注释*]字样。 /** * @file example.h[注释1] * @brief 这是一个注释格式...

    注释规范要求

    下面以C++中的头文件为例来说明如何进行注释,以及注释要求。

    注意:由于blog显示原因,把其中的pre1改为pre,把b1改为b,删掉[注释*]字样。

    /**
    * @file example.h[注释1] 
    * @brief 这是一个注释格式说明文件[注释2] 
    * @author Wang Erxiao[注释3] 
    * @author Si Maguang[注释4] 
    * @date 2011-07-27 22:30:00[注释5] 
    * @version 1.0[注释6] 
    * <pre1><b1>Copyright (C) </b> 1998-2009 Comany Name </pre1>
    * <pre1><b1>email:</b> hao.limin@gmail.com; simaguang@gmail.com[注释7] </pre1>
    * <pre1><b1>company:</b>http://blog.csdn.net/donhao</pre1>
    * <pre1><b1>All rights reserved.</b1></pre1>
    * <pre1><b1>modification:</b1></pre1>
    * <pre1>Write modifications here.</pre1>
    [注释8] */
     
    #include <string>
     
    /** @brief枚举常量. */[注释9] 
    typedef enum DayOfWeek
    {
    SUN = 0,     /**< 星期天 */[注释10] 
    MON = 1,     /**< 星期一 */
    TUE = 2,     /**< 星期二 */
    WED = 3,     /**< 星期三 */
    THU = 4,     /**< 星期四 */
    FRI = 5,     /**< 星期五 */
    SAT = 6      /**< 星期六 */
    }
     
    /**
    * @class example
    * @brief 封装了日志操作。
    *
    * detailed 基于网络的日志系统。
    */[注释11]
     
    class example
    {
    public:
     
    /**
    * @brief Constructor for Example, 这里是简要描述,同时演示了\n
    * 简要描述换行。
    * 这里是详细描述,同时演示了\n
    * 详细描述换行。
    * @param configuationFilePath Defaults to "./ Example.conf". The path and
    * file name of the configuration file.
    */
     
    Example(std::string configuationFilePath = "./ Example.conf");
     
    /** @brief Destructor for Example. */
    ~Example();
     
    /**
    * @defgroup Send_messages 这是Send_messages模块的Title
    * @brief Send_messages模块的简要描述。
    *
    * Send_messages模块的详细描述。
    * @{
    */[注释13] 
     
    /**
    * @brief 向系统发送一条Emergence级别的消息.
    *
    * emerg函数的详细描述。
    * @param[in] message The content of the log message.
    * @return bool
    * @see log
    * @note 注释
    * @since 2008-10-10
    * @exception LogException
    * @deprecated
    */[注释14]
    bool emerg(std::string message);
    /** @} */ //Send_messages模块定义结束,其中包括一个函数。 
     
    /**
    * @addtogroup Send_messages
    * @{[注释15]
    */ 
     
    /**
    * @brief Send a fatal log message to existing appenders.
    * @param[out] message The content of the log message.
    */
    void fatal(std::string message);
     
    /**
    * @brief Send an alert log message to existing appenders.
    * @param[in] message The content of the log message.
    * @return void
    */
    void alert(std::string message);
    /** @} */ //所要添加进的模块结束
     
    /**
    * @name gourp_name
    * @brief gourp_name组的简要注释。
    *
    * gourp_name组的详细注释。
    * @{
    */
     
    /**
    * @brief Send a notice log message to existing appenders.
    * @param[in] message The content of the log message.
    * @return void
    */
    void notice(std::string message);
    /** @} */ //组结束
     
    /**
    * @brief Send a log message with priority priorityLevel to existing appenders.
    * @param[in] priorityLevel The priority of the log message.
    * - LOG_EMERG       0
    * - LOG_FATAL        1
    * - LOG_ALERT       2
    * - LOG_NOTICE      3
    * - LOG_INFO         4[注释16]
    * @param[in] message The content of the log message. 
    * @return void
    */
     
    void log(int priorityLevel, std::string message); 
     
    /**
    * @brief Get the message sending status.
    * @return bool
    */
     
    bool getSendStatus();
     
    /**
    * @file test.h
    * @ingroup Send_messages
    * @brief 添加文件test.h到Send_messages模块。
    */
     
    [注释17] 
     
    /**
    * @namespace std
    * @ingroup Send_messages
    * @brief 添加命名空间std到Send_messages模块。
    */
     
    [注释18] 
     
    /**
    * @class test
    * @ingroup Send_messages
    * @brief 添加类test到Send_messages模块。
    */
    [注释19] 
    };
    

    [注释1]文件名

    [注释2]在这里写文件描述。

    [注释3]作者姓名。注意@author和姓名之间要保持一个空格。

    [注释4]如果为多个作者,则另起一行在@author之后写上作者姓名。

    [注释5]日期。

    [注释6]代码版本。

    [注释7]作者邮箱。

    [注释8]可以根据具体需求来修改以上内容。

    [注释9]简要注释的格式。

    [注释10]成员注释的格式

    [注释11]类注释的格式,其中包括类名(自动生成)、简要注释、详细注释。

    1.       简要描述一定以@brief开始(自动生成)。
    
    2.       简要注释之后空一行才是详细注释。
    

    [注释12]注释换行的方法。

    [注释13]定义模块注释的方法,其模块结束标识为/** @} */

    [注释14]函数注释

    [注释15]将从此处至“/** @} */ //组结束”之前的内容添加至Send_messages模块中。

    [注释16]项目符号标记。

    [注释17]文件test.h属于模块Send_messages。

    [注释18]命名空间std属于模块Send_messages。

    [注释19]类test属于模块Send_messages。
    ————————————————
    版权声明:本文为CSDN博主「Donhao」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
    原文链接:https://blog.csdn.net/donhao/article/details/6640096

    展开全文
  • php 注释规范

    2020-10-28 03:07:32
    php 注释规范,学习php的朋友可以参考下
  • js命名规范与注释规范
  • doxygen 注释规范

    千次阅读 2019-09-02 17:58:18
    文章目录doxygen C/C++注释规范例子变量注释规范函数注释规范结构体注释规范枚举注释规范文件注释规范 doxygen C/C++注释规范例子 变量注释规范 /*!< @brief Number of HW frame done interrupt received */ ...

    doxygen C/C++注释规范例子

    官方使用手册

    附CSDN下载连接:https://download.csdn.net/upload/11657370
    附官网下载连接:http://www.doxygen.nl/download.html#dlmanual

    变量注释规范

        /*!< @brief Number of HW frame done interrupt received */ 
        uint16_t                 hwFrameDoneCount;
    

    函数注释规范

    /*!
     *  @brief  Function is executed after the HWA CFAR algorithm. It reduces the
     *  number of detected objects performed by CFAR algorithm. It selects only
     *  those objects with peaks greater than its neighbors.
     *
     *
     *  @param[in]  numDetectedObjects  Number of detected objects by HWA CFAR algorithm
     *
     *  @param[in]  detBuffptr          Pointer to range-doppler matrix which was
     *                                  used by CFAR alogorithm to generate detected
     *                                  objects, size number of range bins times number
     *                                  of doppler bins.
     *
     *  @param[in]  cfarObjptr          Pointer to the output structure generated
     *                                  by CFAR algorithm, contains list of detected objects.
     *
     *  @param[in]  fftBuffptr          Pointer to 2nd D FFT buffer with complex symbols. 
     *                                  The size of buffer is 
     *                                  numRangeBins * numDopplerBins * (numVirtualAntAzim + numVirtualAntElev).
     *
     *  @param[out]  objOut             Output pointer to the structure with with selected objects. 
     *                                  The function fills range and doppler index of the object.
     *
     *  @param[out]  dstPtrAzim         Output pointer (local memory of HWA) filled with antenna 
     *                                  symbols of selected objects for azimuth calculation.
     *
     *  @param[out]  dstPtrElev         Output pointer (local memory of HWA) filled with antenna 
     *                                  symbols of selected objects for elevation calculation.
     *
     *  @param[in]  numTxAnt            Number of Tx antennas
     *
     *  @param[in]  numRxAnt            Number of Rx antennas
     *
     *  @param[in]  numVirtualAntAzim   Number of virtual azimuth Rx antennas
     *
     *  @param[in]  numVirtualAntElev   Number of virtual elevation Rx antennas
     *
     *  @param[in]  numDopplerBins      Number of Doppler bins
     *
     *  @param[in]  numRangeBins        NUmber of Range bins
     *
     *  @param[in]  minRangeIdx         minimum range index to be exported
     *
     *  @param[in]  maxRangeIdx         maximum range index to be exported
     *
     *
     *  @param[in]  groupInDopplerDirection    peak grouping in Doppler direction 0-disabled, 1-enabled
     *
     *  @param[in]  groupInRangeDirection      peak grouping in Range direction 0-disabled, 1-enabled
     *
     *  @return numObjOut Number of selected objects
        *        -<em>false</em> fail
        *        -<em>true</em> succeed
     *
     */
    bool postDetectionProcessing(uint32_t numDetectedObjects,
                                        uint16_t* detBuffptr,
                                        cfarDetOutput_t*  cfarObjptr,
                                        uint32_t* fftBuffptr,
                                        MmwDemo_detectedObj *objOut,
                                        uint32_t *dstPtrAzim,
                                        uint32_t *dstPtrElev,
                                        uint32_t numTxAnt,
                                        uint32_t numRxAnt,
                                        uint32_t numVirtualAntAzim,
                                        uint32_t numVirtualAntElev,
                                        uint32_t numDopplerBins,
                                        uint32_t numRangeBins,
                                        uint32_t minRangeIdx,
                                        uint32_t maxRangeIdx,
                                        uint32_t groupInDopplerDirection,
                                        uint32_t groupInRangeDirection);
    

    结构体注释规范

    /**
     * @brief
     *  Millimeter Wave Demo MCB
     *
     * @details
     *  The structure is used to hold all the relevant information for the
     *  Millimeter Wave demo
     */
    typedef struct MmwDemo_MCB_t
    {
        /*! @brief   Configuration which is used to execute the demo */
        MmwDemo_Cfg                 cfg;
        
        /*! @brief CLI related configuration */
        MmwDemo_CliCfg_t           cliCfg;
    
        /*! @brief   CLI related configuration */
        MmwDemo_CliCommonCfg_t      cliCommonCfg;
    
    
        /*! * @brief   Handle to the SOC Module */
        SOC_Handle                  socHandle;
    
        /*! @brief   UART Logging Handle */
        UART_Handle                 loggingUartHandle;
    
        /*! @brief   UART Command Rx/Tx Handle */
        UART_Handle                 commandUartHandle;
    
        /*! @brief   This is the mmWave control handle which is used
         * to configure the BSS. */
        MMWave_Handle               ctrlHandle;
    
        /*! @brief   Data Path object */
        MmwDemo_DataPathObj         dataPathObj;
    
        /*! @brief   Demo Stats */
        MmwDemo_Stats               stats;
        
        /*! @brief   this structure is used to hold all the relevant information 
         for the mmw demo LVDS stream*/
        /*Unverified code. Conflicts with data path processing and should not be used.*/ 
        MmwDemo_LVDSStream_MCB_t    lvdsStream;
    
    } MmwDemo_MCB;
    

    枚举注释规范

    /// \brief xxx枚举变量的简要说明
    ///
    /// xxx枚举变量的详细说明--枚举变量的详细说明和函数的详细说明
    ///的写法是一致的。每个枚举变量下可以进行单独说明
    enum{
    		em_1,///< 枚举值1的说明
    		em_2,///< 枚举值2的说明
    		em_3 ///< 枚举值3的说明
    };
    

    文件注释规范

        /*!
        * \file Ctext.h
        * \brief 概述 
        * 
        *详细概述 
        * 
        * \author 作者名字
        * \version 版本号(maj.min,主版本.分版本格式) 
        * \date 日期 
        */
    
    展开全文
  • MyEclipse注释规范

    2015-08-23 13:27:52
    MyEclipse注释规范,包括类的注释,方法注释等,方便快捷生成规范的注释
  • JAVA注释规范

    2020-06-07 18:31:17
    编码规范(一)----JAVA注释规范 JAVA注释规范: link.

    编码规范(一)----JAVA注释规范

    JAVA注释规范: link.

    展开全文
  • C语言注释规范.pdf

    2020-09-11 10:17:42
    C 语言注释规范 1. 注释原则 同一软件项目开发中尽量保持代码注释规范和统一 注释方便了代码的阅读和维护 边写代码边注释 修改代码时要相应修改注释 保证注释和代码的一致性 注释 要 简洁明确不要出现形容词 对于写...
  • 代码注释规范

    2012-11-29 23:25:37
    代码注释规范
  • java代码注释规范文档

    2018-09-18 10:33:34
    后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等
  • C++注释规范

    2019-02-20 17:52:13
    C++注释规范
                   

    公司内有一个统一的注释规范相当重要,下面的文章转载自:http://hi.baidu.com/buptyoyo/blog/item/fc8bdfee2ea1793326979114.html

     

     

    最近一直在给项目代码加注释,因为结项有一项工程性的要求是注释占到总行数的额50%,这几天可苦了我们几个。前几天为了统一项目组的注释规范,专门整理了一份,以后可能也用得着,放着备份下。

    源文件头部注释

    Ø 列出:版权、作者、编写日期和描述。

    Ø 示例:

    /*************************************************Copyright:buptAuthor:Date:2010-08-25Description:描述主要实现的功能**************************************************/ 

    每行不要超过80个字符的宽度。

    函数头部注释

    /功能、输入参数、输出参数、返回值、调用关系(函数、表)等。

    Ø 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议

    要包含在内。

     

    /*************************************************Function:       // 函数名称Description:    // 函数功能、性能等的描述Calls:          // 被本函数调用的函数清单Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)Input:          // 输入参数说明,包括每个参数的作                  // 用、取值说明及参数间关系。Output:         // 对输出参数的说明。Return:         // 函数返回值的说明Others:         // 其它说明*************************************************/ 

     

    数据结构声明的注释(包括数组、结构、类、枚举等)

    如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。

     

    Ø 示例:可按如下形式说明枚举/数据/联合结构。

     

    /* sccp interface with sccp user primitive message name */enum SCCP_USER_PRIMITIVE{    N_UNITDATA_IND, /* sccp notify sccp user unit data come */    N_NOTICE_IND,   /* sccp notify user the No.7 network can not */                    /* transmission this message */    N_UNITDATA_REQ, /* sccp user's unit data transmission request*/}; 

    全局变量的注释

    Ø 包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

     

    示例:

    /* The ErrorCode when SCCP translate *//* Global Title failure, as follows */      // 变量作用、含义 

     

     

     

     

    对代码的注释

    注释总是加在程序的需要一个概括性说明或不易理解或易理解错的地方。注释语言应该简练、易懂而又含义准确,避免二义性;所采用的语种首选是中文,如有输入困难、编译环境限制或特殊需求也可采用英文。注释应与其描述的代码相近,对代码的注释统一放在其上方,避免在一行代码或表达式中间使用注释。上方注释与其上面的代码用空行隔开(较紧凑的代码除外)。

    注意:注释应与所描述内容进行同样的缩进。

     

               

    再分享一下我老师大神的人工智能教程吧。零基础!通俗易懂!风趣幽默!还带黄段子!希望你也加入到我们人工智能的队伍中来!https://blog.csdn.net/jiangjunshow

    展开全文
  • C 注释规范

    千次阅读 2018-11-07 15:55:14
    C 注释规范
  • Javascript注释规范

    万次阅读 2017-11-14 15:16:37
    Javascript注释规范
  • Swift 注释规范和文档注释

    千次阅读 2019-04-29 19:08:42
    Swift 注释规范 目录 Swift 注释规范 一、 普通注释 二、 MARK、TODO、FIXME 三、 文档注释 四、 Playground注释 今天,我知道我写是什么,上帝和我知道 明天,我知道这个代码什么意思, 后天,我知道这是...
  • 代码和注释规范 .pdf

    2020-12-11 00:22:15
    JAVA编程规范 代码和注释规范 文档编号 版 本 1.0 JAVA编程规范 代码规范 注释规范 第 1 页 共 8 页 JAVA编程规范 代码和注释规范 1引言 本文档对Java代码的编程方式风格做了统一规范目的是减少编程人员代码编写中的...
  • Java 注释规范

    2021-03-19 23:15:31
    注释规范 类注释:每个类前面必须加上注释,模板如下: /** *类的说明 *@author 创建者名 *@Date 创建日期 *@version 属性注释:每个属性前面加上注释 /** 提示信息 */ 方法注释 /** *方法的说明 *@param *...
  • golang 注释规范

    千次阅读 2020-03-09 14:27:41
    注释的意义 注释可以帮我们很好的完成文档... 下面从包注释、结构体(接口)注释、函数(方法)注释、代码逻辑注释以及注释规范方面进行说明。 包注释 每个包都应该有一个包注释,一个位于package子句之前行注...
  • 编码规范 注释规范 代码风格 华为 JAVA
  • c语言注释规范

    2021-03-19 14:23:32
    项目开发中,尽量保持代码注释规范和统一。 注释方便了代码的阅读和维护。 边写代码边注释,修改代码时要相应修改注释,保证注释和代码的一致性。 注释要简洁明确,不要出现形容词。 通过注释可以快速知道所写函数的...
  • PHP 注释规范

    2019-11-27 15:54:11
    PHP 注释规范 注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。 php里面常见的几种注释方式: 1.文件头的注释,介绍文件名,功能以及作者版本号等信息 /** ...
  • javascript中的注释规范

    2017-07-21 08:48:01
    javascript中的注释规范
  • eclipse代码/注释规范

    2017-01-08 13:00:04
    eclipse代码/注释规范

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 14,147
精华内容 5,658
关键字:

注释规范