YMMV(差异很大),但通常我只为更高级的内容添加注释。 例如,我更喜欢注释函数规范(C 语言人士的函数原型 :-)),以便查看我代码的人知道函数/方法 *做* 什么。 此外,我通常在我的包的头部添加注释,以便人们知道该包的职责是什么。 我极少在实际代码中添加注释,除非我正在使用非常复杂的算法且动作不明显。 我更喜欢使用长而描述性的名称,而不是求助于注释。 例如,如果你看到
function Exist_Device(Serial_Number : Integer) return Booleanisbeginfor I in Device_Table.Range loopif Device_Table(I).Serial = Serial_Number thenreturn True;end if;end loop;
return False;end Exist_Device;
就非常清楚它做什么,而无需注释。
“反馈不能支付账单,因此它不能替代支付合适的工资。”
确实如此。 赞赏是好的,我同意它可以成为强大的激励力量(我为此原因为开源项目做贡献)。 然而,由于“谢谢”非常廉价,因此存在您的员工认为“谢谢”只是廉价替代更高薪水的风险。 如果员工有这种感觉,“谢谢”可能会适得其反。 看看许多关于激励礼品的呆伯特漫画...
撰写评论
YMMV(差异很大),但通常我只为更高级的内容添加注释。 例如,我更喜欢注释函数规范(C 语言人士的函数原型 :-)),以便查看我代码的人知道函数/方法 *做* 什么。 此外,我通常在我的包的头部添加注释,以便人们知道该包的职责是什么。 我极少在实际代码中添加注释,除非我正在使用非常复杂的算法且动作不明显。 我更喜欢使用长而描述性的名称,而不是求助于注释。 例如,如果你看到
function Exist_Device(Serial_Number : Integer) return Boolean
is
begin
for I in Device_Table.Range loop
if Device_Table(I).Serial = Serial_Number then
return True;
end if;
end loop;
return False;
end Exist_Device;
就非常清楚它做什么,而无需注释。
“反馈不能支付账单,因此它不能替代支付合适的工资。”
确实如此。 赞赏是好的,我同意它可以成为强大的激励力量(我为此原因为开源项目做贡献)。 然而,由于“谢谢”非常廉价,因此存在您的员工认为“谢谢”只是廉价替代更高薪水的风险。 如果员工有这种感觉,“谢谢”可能会适得其反。 看看许多关于激励礼品的呆伯特漫画...