代码管理

只看该作者 · 2015-6-2 21:30

写了很多代码，有时候回头去看看，真的很纠结，完全不知道自己当初为啥这么做。那么问题来了，大家都是怎么对自己的代码进行注释的。比如公司写代码有什么要求，比如程序流程图啊，等等，大家说说呗。发发你们公司的代码相关的要求文档。

1万 · 2015-6-2 22:22

帮顶，对于这方面知道的不多，希望高手帮助你。。

只看该作者 · 2015-6-2 23:13

高手来解答

只看该作者 · 2015-6-3 07:26

工具来说是doxygen，但再强的工具也得人去用去用，通常是懒得去写那么详细。。。

3万 · 2015-6-3 08:24

我很少画流程图；
自己写的，没有看不懂的；
至少我会加注释的；

只看该作者 · 2015-6-3 08:53

个人理解。
变量、函数命名很重要。好的名字随便在哪里，都能看出什么意思。用汉语拼音简写的就算了。
程序结构也很重要。不一定非要画出图来，但是模块间的关系要清晰。哪些模块是独立的，哪些模块是相互有联系的。
有一些代码，光看表面看不出意思，甚至乍一看明显错的，但其实是特意为之的，就要说明原因为什么这么写。

只看该作者 · 2015-6-3 09:37

doxygen很好用

只看该作者 · 2015-6-3 13:49

大家说的挺好的

只看该作者 · 2015-6-5 09:01

还有没有好的资料

只看该作者 · 2015-6-5 09:07

关键是注释啊！不然久了都容易忘记

只看该作者 · 2015-6-5 09:07

596142041 发表于 2015-6-5 09:07
关键是注释啊！不然久了都容易忘记

好吧，注释是得好好注意

只看该作者 · 2015-6-5 11:32

我还以为是用版本库管理代码呢

1万 · 2015-6-5 22:21

不错，都说的很好。。

只看该作者 · 2015-6-11 15:13

我只知道说要画流程图的都是LOW B

只看该作者 · 2015-6-11 17:32

yudie 发表于 2015-6-11 15:13
我只知道说要画流程图的都是LOW B

什么意思

只看该作者 · 2015-6-11 17:50

都没有流程图的习惯，代码关键地方加注释，还有楼上的函数，模块名等要表达它的意思！！程序模块化很重要

只看该作者 · 2015-6-11 20:45

代码的关键步骤加注释，函数模块加注释，不加注释都会忘的

只看该作者 · 2015-6-12 14:13

本帖最后由 LZR13179 于 2015-6-12 14:14 编辑

使用VisualSVN-Server-2.5.8管理代码,代码格式使用astyle进行风格处理，使用SI的宏(按照doxygen注释风格自动生成)，最后使用doxywizard生成api文档。最后上传到网盘备份。
心得使用印象笔记记录。
/**
*@brief:                icc_powerup
*@details:             ic卡上电后并对其激活
*@param[in]             uint8_t voltage  电压
                              uint8_t slot    卡槽
*@param[out]       SLOT_PARAM* SC
*@retval:             ERR_POWERUP_VOLTAGE_INVALID
*/

只看该作者 · 2015-6-12 20:14

VisualSVN-Server-2.5.8是个什么软件

只看该作者 · 2015-6-12 21:08

LZR13179 发表于 2015-6-12 14:13
使用VisualSVN-Server-2.5.8管理代码,代码格式使用astyle进行风格处理，使用SI的宏(按照doxygen注释风格自 ...

不错是个好东西

代码管理

技术奇才奖章

欢快之小溪

缘定三生

社区建设奖章

技术新星奖章

沉静之湖泊

常驻人口

无冕之王奖章

湍急之河流

技术领袖奖章

十世金身

坚毅之洋流

荣誉元老奖章

精华达人奖章

七世轮回

技术导师奖章

涓涓之细流

伴坛终老

甘甜之泉水

精英会员奖章

技术高手奖章

经常做客

以坛为家