文档不足的大型函数¶
ID: cpp/poorly-documented-function
Kind: problem
Security severity:
Severity: warning
Precision: medium
Tags:
- maintainability
- documentation
- statistical
- non-attributable
Query suites:
- cpp-security-and-quality.qls
此规则查找注释行过少的大型函数。随着函数变得越来越复杂，文档变得越来越重要，而缺乏文档会使维护变得更加困难。
建议¶
添加注释以记录函数的目的。尤其是大型复杂的函数需要详细的文档，不仅因为它们难以理解，而且文档化过程可能会发现函数可以拆分成更小、更具凝聚力的函数。