代码注释（code comments)

最新推荐文章于 2023-08-22 11:20:00 发布

yet

最新推荐文章于 2023-08-22 11:20:00 发布

阅读量1.1k

点赞数

本文链接：https://blog.csdn.net/u010286868/article/details/51218571

版权

本文介绍了代码注释中常见的标记，如FIXME、HACK、TODO等，用于标注需要修正、临时解决方案或待办事项的代码。同时也讨论了代码风格的重要性，尤其是在团队开发中保持一致性、非侵入性、易修改和难破坏的注释风格。专家Allen Holub提倡对齐注释的左侧边缘，以提高代码可读性。

摘要由CSDN通过智能技术生成

常见的代码tag：

FIXME - should be corrected.
HACK - a workaround.
TODO - something to be done.
UNDONE - a reversal or “roll back” of previous code.
XXX - warn other programmers of problematic or misguiding code
UX - user experience, notice about non-trivial code.

例如：

/* TODO: How about auto-correcting small spelling errors? */
    /* FIXME: This won't work if the file is missing. */
    /* XXX: This method badly needs refactoring: should switch by core type. <mbp> */

常见的代码风格：
There are many stylistic alternatives available when considering how comments should appear in source code. For larger projects involving a team of devel