Start here

Home
About Klocwork
What's new
Fixed issues
Release notes
Installation

Reference

C/C++ checkers
Java checkers
C# checkers
MISRA C 2004 checkers
MISRA C++ 2008 checkers
MISRA C 2012 checkers
MISRA C 2012 checkers with Amendment 1
Commands
Metrics
Troubleshooting
Reference

Product components

C/C++ Integration build analysis
Java Integration build analysis
Desktop analysis
Refactoring
Klocwork Static Code Analysis
Klocwork Code Review
Structure101
Tuning
Custom checkers

Coding environments

Visual Studio
Eclipse for C/C++
Eclipse for Java
IntelliJ IDEA
Other

Administration

Project configuration
Build configuration
Administration
Analysis performance
Server performance
Security/permissions
Licensing
Klocwork Static Code Analysis Web API
Klocwork Code Review Web API

Community

View help online
Visit RogueWave.com
Klocwork Support
Rogue Wave Videos

Legal

Legal information

Using annotations

You can annotate entities in any system model that you can see in source cross-reference. In Klocwork Static Code Analysis, you can only add or modify annotations for the System Model as user models are not available.

All users have read/write access to annotations.

Annotations can be useful for several purposes. You can add annotations

  • to code entities as you learn about the code. These annotations may be useful additions to source code comments.
  • to code entities to instruct other software developers about required changes, or to inform them about changes you have made or are planning to make
  • that describe guidelines about system components or refer to external documents such as project plans, presentations and specifications

Tips for adding annotations

  • In the case where there are multiple entities with the same name, place, and type (for example, multiple constructors or overloaded methods), an annotation added to one of these entities will be attached to all of them.
  • All characters are acceptable input, but HTML tags are not recognized and will appear only as typed in the annotation.
  • While it is possible to create lengthy annotations, you may prefer to link to an associated document.