| 网站首页 | 业界新闻 | 小组 | 威客 | 人才 | 下载频道 | 博客 | 代码贴 | 在线编程 | 编程论坛
欢迎加入我们,一同切磋技术
用户名:   
 
密 码:  
共有 451 人关注过本帖
标题:有代码注释分格好的说说技巧。。。。。
只看楼主 加入收藏
wengege
Rank: 2
等 级:论坛游民
帖 子:148
专家分:93
注 册:2012-7-23
结帖率:89.47%
收藏
已结贴  问题点数:10 回复次数:4 
有代码注释分格好的说说技巧。。。。。
if(ip != NULL){
        //设置*********
        I2C_EE_SequentialWrite((u8 *)ip+3, EEPROM_IP_Address, 12);   
        // 回发IP   
        USARTx_SendData(ip, 15);                    
    }
    if(port != NULL){
        //设置*********
        I2C_EE_SequentialWrite((u8 *)port+4, EEPROM_PORT_Address, 4);  
        // 回发********  
        USARTx_SendData(port, 8);            
    }   
    if(number != NULL){
        //设置*******
        I2C_EE_SequentialWrite((u8 *)number+7, EEPROM_NUMBER_Address, 8);
         //回发******
        USARTx_SendData(number, 15);         
    }

感觉我不大会写注释, 写些注释有时候看着就烦。。 希望有注释分格好的说说。。。
搜索更多相关主题的帖子: number 技巧 
2012-11-15 20:11
jk_love
Rank: 8Rank: 8
等 级:蝙蝠侠
威 望:1
帖 子:196
专家分:965
注 册:2012-10-22
收藏
得分:5 
感觉就是不必要的注释不要注释,注释要简明扼要,注释说明函数功能函数功能;最好用 /***注释***/的方式比//注释 ,如果涉及到平台的话第二种方式有可能编译不过
2012-11-15 20:35
jk_love
Rank: 8Rank: 8
等 级:蝙蝠侠
威 望:1
帖 子:196
专家分:965
注 册:2012-10-22
收藏
得分:0 
/***************************************************************************
Summary:
    This function performs a read operation with 8-bit target sub address
    and no ack.
Description:
    This function is used to read from a target with 8-bit sub address.
   
Returns:
    TODO:
See Also:
    BI2C_P_Read(), BI2C_P_ReadA16(), BI2C_P_ReadNoAddr(), BI2C_EDDCRead().
****************************************************************************/
BERR_Code BI2C_P_ReadNoAck(
    void *context,                /* Device channel handle */
    uint16_t chipAddr,                    /* chip address */
    uint8_t subAddr,                    /* 8-bit sub address */
    uint8_t *pData,                /* pointer to memory location to store read data  */
    size_t length                        /* number of bytes to read */
    );
2012-11-15 20:38
zklhp
Rank: 20Rank: 20Rank: 20Rank: 20Rank: 20
来 自:china
等 级:贵宾
威 望:254
帖 子:11485
专家分:33241
注 册:2007-7-10
收藏
得分:5 
搜本版 有个大牛一个帖子讲了几个注释的小技巧 可以学习学习
2012-11-15 21:18
wengege
Rank: 2
等 级:论坛游民
帖 子:148
专家分:93
注 册:2012-7-23
收藏
得分:0 
回复 4楼 zklhp
呵呵, 谢谢啦。。

打好基础,学会站在巨人的肩膀上!
2012-11-16 09:21
快速回复:有代码注释分格好的说说技巧。。。。。
数据加载中...
 
   



关于我们 | 广告合作 | 编程中国 | 清除Cookies | TOP | 手机版

编程中国 版权所有,并保留所有权利。
Powered by Discuz, Processed in 0.025406 second(s), 10 queries.
Copyright©2004-2024, BCCN.NET, All Rights Reserved