c – 准备公共标题以供发布

我很想知道你清理公共头文件的常用程序
分发给客户.

我想听听你的意见的一些事情是：

评论不适用于外部消费.一般来说,我喜欢保持文档密切
这样的代码和评论可能不是一个好主意分享：

/**
 * @todo Should we change the signature of this function to
 * make it obvIoUs that xxx is really yyy?
 */

也许：

/**
 * @todo Add support for feature X
 */

选项卡样式不一致：

void functionA(int a,int b,int c,int d);

void functionB(int a,int c);

是否有任何工具可用于准备标题或代码以供发布？

解决方法

对于任何涉及多个开发人员的项目,你应该总是在任何延长的时间段内,以及随后发布的源代码,SCAN FOR OBSCENITIES(以及你不应该说的其他事情,例如,“我的老板让我这样做”,“这段代码非常糟糕”,等等.此外,拼写检查评论可能会有所帮助,因为人们错误地拼写单词会损害您的可信度.