none
头文件加了函数参数注释,cpp文件还需要加函数参数注释吗? RRS feed

  • 问题

  •   现在我有一个疑惑:
    头文件加了函数参数注释,cpp文件还需要加函数参数注释吗?

        比如,在头文件声明:

    // 头文件声明
    
    
    /*!
    \brief 两数相加
    \param nLeftNum   左操作数
    \param nRightNum  右操作数
    \return 两数相加结果
    */
    long Add(int nLeftNum,int nRightNum);
    
         是否还要再cpp文件添加:
    // cpp文件实现
    
    /*!
    \brief 两数相加
    \param nLeftNum   左操作数
    \param nRightNum  右操作数
    \return 两数相加结果
    */
    
    long Add(int nLeftNum,int nRightNum)
    {
    
    ......
    }
    
        我的看法是头文件肯定是要添加函数参数注释的,因为毕竟要提供给别人接口,就是给别人看的。开始我认为在cpp文件中不需要添加函数参数注释,但是后来我想以后的代码维护人员也需要看的吧,难道要别人翻到头文件来看吗?

        大家对此的看法是怎样的呢?

    前无古人,后无来者
    2009年12月20日 10:57

答案

全部回复