d**o 发帖数: 864 | 1 我可以理解在一个team里,有一定的标准和习惯。但我从来没有跟人编程合作过。自己
的项
目写的代码有将近10万行了,但是从来没有养成documentation的好习惯,或者说,不
知道
怎么养成好的习惯和方式。也不是都不做,而是不够严格。
请高手分享经验,或者工具。 |
r****y 发帖数: 26819 | 2 好的习惯就是把代码写到不用documentation也很容易看懂的程度。
【在 d**o 的大作中提到】 : 我可以理解在一个team里,有一定的标准和习惯。但我从来没有跟人编程合作过。自己 : 的项 : 目写的代码有将近10万行了,但是从来没有养成documentation的好习惯,或者说,不 : 知道 : 怎么养成好的习惯和方式。也不是都不做,而是不够严格。 : 请高手分享经验,或者工具。
|
c*********e 发帖数: 16335 | 3 多写注释,让自己也看得懂。最好在注释里把自己名字加上去,等将来自己离开公司了
,自己的名字还在code里面,多好。
【在 d**o 的大作中提到】 : 我可以理解在一个team里,有一定的标准和习惯。但我从来没有跟人编程合作过。自己 : 的项 : 目写的代码有将近10万行了,但是从来没有养成documentation的好习惯,或者说,不 : 知道 : 怎么养成好的习惯和方式。也不是都不做,而是不够严格。 : 请高手分享经验,或者工具。
|
d**********x 发帖数: 4083 | 4 要“自己看懂”注释量感觉远远不够
所以还是code review,然后reviewer要求加注释比较好。
自己
,不
【在 c*********e 的大作中提到】 : 多写注释,让自己也看得懂。最好在注释里把自己名字加上去,等将来自己离开公司了 : ,自己的名字还在code里面,多好。
|
s*********t 发帖数: 1663 | 5 write api, documentation, and test before you implement anything.
【在 d**o 的大作中提到】 : 我可以理解在一个team里,有一定的标准和习惯。但我从来没有跟人编程合作过。自己 : 的项 : 目写的代码有将近10万行了,但是从来没有养成documentation的好习惯,或者说,不 : 知道 : 怎么养成好的习惯和方式。也不是都不做,而是不够严格。 : 请高手分享经验,或者工具。
|
b*******s 发帖数: 5216 | 6 keep stories of scrum or detailed design drafts
write code comments, maybe in doxygen format
updating internal wiki
【在 s*********t 的大作中提到】 : write api, documentation, and test before you implement anything.
|