c++ - 准备要发布的公共(public) header

Question

我很想听听你们有哪些清理公共(public)头文件的例程分发给客户。

我想听听您的意见是:

评论不适合外部使用。一般来说，我喜欢保持文档关闭像这样分享代码和评论可能不是一个好主意:

/**
 * @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 b,
               int c);

是否有任何工具可以为发布准备 header 或代码？

Answer 1

对于涉及多个开发人员的任何项目，任何延长的时间段以及该源代码的后续版本，您都应该始终扫描 OBSCENITIES(以及其他您不应该说的话，例如，“我的老板让我做这个”，“这段代码太糟糕了”，等等)。此外，对评论进行拼写检查也很有帮助，因为人们拼错单词会降低您的可信度。