由买买提看人间百态

boards

本页内容为未名空间相应帖子的节选和存档,一周内的贴子最多显示50字,超过一周显示500字 访问原贴
Programming版 - 如何养成好的documentation习惯
相关主题
编程习惯问题map是用什么data structure来implement的?
一个multithread的问题(是不是有人觉的很简单?)再来讨论一直算法课的作业吧
VB.NET转成VBApython注释问题。
推书有用Agile的吗?
是react几种代码混合好还是angular分开好Agile/waterfall这些概念是什么书里提出来的?
谁给推荐一下scrum或者agile prog. management方面的书?MATLAB里面怎么样可以方便得使一大部分文字同时变成注释文字呢?
How does YAHOO calculate RSI? (转载)Job opportunities in GE (contractor to Hire)
请教template和factory有啥区别?Development methodologies... Do you really follow one?
相关话题的讨论汇总
话题: 习惯话题: 养成话题: 注释话题: 如何
进入Programming版参与讨论
1 (共1页)
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.
1 (共1页)
进入Programming版参与讨论
相关主题
Development methodologies... Do you really follow one?是react几种代码混合好还是angular分开好
说几个backend从C++导向Java的知名公司吧谁给推荐一下scrum或者agile prog. management方面的书?
大家来讨论讨论为什么healthcare.gov会fail吧?How does YAHOO calculate RSI? (转载)
求转行建议请教template和factory有啥区别?
编程习惯问题map是用什么data structure来implement的?
一个multithread的问题(是不是有人觉的很简单?)再来讨论一直算法课的作业吧
VB.NET转成VBApython注释问题。
推书有用Agile的吗?
相关话题的讨论汇总
话题: 习惯话题: 养成话题: 注释话题: 如何