名稱: Inaccurate Source Code Comments
The source code contains comments that do not accurately
describe or explain aspects of the portion of the code with which the comment is
associated.
一般資訊
引入方式
Implementation適用平台
程式語言
類別： Not Language-Specific (Undetermined)常見後果
| 範圍 | 影響 | 可能性 |
|---|---|---|
| Other | Reduce Maintainability 注意：This issue makes it more difficult to maintain the product, which indirectly affects security by making it more difficult or time-consuming to find and/or fix vulnerabilities. It also might make it easier to introduce vulnerabilities. | |
| Other | Increase Analytical Complexity 注意：When a comment does not accurately reflect the associated code elements, this can introduce confusion to a reviewer (due to inconsistencies) or make it more difficult and less efficient to validate that the code is implementing the intended behavior correctly. |
潛在緩解措施
Phases : ImplementationVerify that each comment accurately reflects what is intended to happen during execution of the code.
偵測方法
Manual Static Analysis
Compare the comments to the actual code itself to ensure the comment is consistent with the code. If an inconsistency exists, consult available documentation for developers of the product (design, libraries, APIs, etc.) Note that documentation might be stored in different places than the code repository.有效性 : Moderate
漏洞對應備注
理由說明 : This CWE entry is at the Base level of abstraction, which is a preferred level of abstraction for mapping to the root causes of vulnerabilities.備註 : Carefully read both the name and description to ensure that this mapping is an appropriate fit. Do not try to 'force' a mapping to a lower-level Base/Variant simply to comply with this preferred level of abstraction.
參考資料
REF-963
Providing a Framework for Effective Software Quality AssessmentRobert A. Martin, Lawrence H. Shafer.
https://www.researchgate.net/publication/285403022_PROVIDING_A_FRAMEWORK_FOR_EFFECTIVE_SOFTWARE_QUALITY_MEASUREMENT_MAKING_A_SCIENCE_OF_RISK_ASSESSMENT
提交
| 名稱 | 機構 | 日期 | 發布日期 | Version |
|---|---|---|---|---|
| CWE Content Team | MITRE | 3.2 |
修改記錄
| 名稱 | 機構 | 日期 | 備註 |
|---|---|---|---|
| CWE Content Team | MITRE | updated Relationships | |
| CWE Content Team | MITRE | updated Applicable_Platforms, Demonstrative_Examples, Potential_Mitigations | |
| CWE Content Team | MITRE | updated Description | |
| CWE Content Team | MITRE | updated Relationships | |
| CWE Content Team | MITRE | updated Mapping_Notes | |
| CWE Content Team | MITRE | updated Common_Consequences, Description, Name, Time_of_Introduction | |
| CWE Content Team | MITRE | updated Demonstrative_Examples, Detection_Factors |
