编码规范-如何写个优美的函数

13 篇文章 0 订阅
8 篇文章 0 订阅

6.函数
6.1.函数定义
① 格式为:[static/virtual] 函数返回值 函数名称(参数列表);
② 能区分纯虚函数、虚函数和非虚函数;

样例:

protected:
    /**
     * @brief       具体实现函数,实现窗口下方的按钮F1的点击事件,若子类窗口该按钮有具体内容则需要子类重载实现,无具体内容则不需要子类重载实现
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    virtual void OnHandleF1Clicked(void);

    //为了统一接口和调用,以下函数可直接使用,不建议子类重载再实现
public:
    /**
     * @brief       初始化窗口下方的工具栏(f1~f10),具体实现交由子类的OnInitToolBar()函数
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void InitToolBar(void);
    /**
     * @brief       加载输入选项
     * @author      hls
     * @date        2014-07-09
     * @param[in|out]需要加载的输入选项值
     * @retval      true    加载成功
     * @retval      false   加载失败
    */
    bool LoadQBOptions(CSelectHelp& helpQBOptions);

public slots:
    /**
     * @brief       槽函数,处理窗口下方的按钮F1的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleF1Clicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮主页的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleHomeClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮Num的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleNumClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮帮助的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleHelpClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮返回的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleReturnClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮Tab的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleTabClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮Fn的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleFnClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮确认的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleOkClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮向左的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleLeftClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮向右的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleRightClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮向上的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleUpClicked(void);

    /**
     * @brief       槽函数,处理窗口下方的按钮向下的点击事件
     * @author      hls
     * @date        2014-06-25
     * @param       无
     * @return      无
    */
    void HandleDownClicked(void);

6.2.函数命名
① 采用大小写混合,不使用下划线。多个单词或单词缩写之间靠大写字母来区分。如:qint64 HandleRecvedData(char* pdata)。
② 函数首字母大写为公司函数,小写为qt函数。
③ 一般采用动词+名称组合。
④ 布尔型函数一般为:Is函数名称。如:IsRT208Dev()。
⑤ 函数名称长度最好能控制在20个字母之内,可以适当考虑英文缩写。
⑥ 相关模块、相似功能的函数命名规则一致。
⑦ 优先采用行业内、公司内、部门内的业务术语。
⑧ 尽可能采用英文,避免采用拼音及拼音缩写。
⑨ 命名中不要使用a/b/c 1/2/3类似的序号来区分不同的函数及参数列表中的参数名称。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值