JavaScript is not currently enabled, but is required for full
CodeSonar manual search and browse functionality.
If you are viewing this file in your hub's Web GUI, enable
JavaScript in your browser: you will also need it for GUI
functionality.
If you opened this file directly from disk, your browser may be
directly suppressing JavaScript functionality: certain browsers
perform this suppression on local files (but not files delivered by
web servers) for security reasons.
-
If you access the manual through the hub's Web GUI, the
functionality will not be suppressed because the hub is a web
server.
-
Alternatively, your browser may allow you to explicitly
disable the security setting that suppresses functionality. See
the CodeSonar
FAQ for more information.
Quick Start (Windows Build Wizard)
The Windows Build Wizard is most useful for C and C++
projects.
- Eclipse users (C/C++/Java) may prefer to use the CodeSonar
plug-in for Eclipse.
The Eclipse
Plug-in Tutorial provides an introduction to installing and
using the plug-in.
- While you can use the Windows Build Wizard for Java and C#
projects, it is generally more straightforward to use the command
line build. See Quick Start
(Command Line).
- For other languages, the Windows Build Wizard cannot be used. See
Quick Start (Command
Line).
This section is designed to get you started using CodeSonar as
quickly as possible. If you get stuck, see the links provided for
more detailed information. For a guided introduction to CodeSonar
see the tutorial.
Overview
In most cases we recommend starting with the CodeSonar tutorial. However, if
you want to get started as quickly as possible (for example, because
you have used CodeSonar before and just need a refresher), the steps
are as follows.
- Install CodeSonar, if you have not already done so: see
section Installing or Upgrading
CodeSonar.
- Set up a hub, if one is not already running: see section
Installation: Setting Up The
Hub.
- Build and analyze your project.
- Browse the analysis results.
- Start up your regular build environment (for example, Visual
C++) and load your software project ready for building.
- Invoke the CodeSonar build wizard from the Windows Start menu:
(If there is no Start menu item,
use the Windows file explorer to navigate to the \codesonar\bin subfolder of the CodeSonar
installation folder, then double-click hookcs[.exe].
- On the first screen of the wizard specify a Save As name and directory for your CodeSonar
project, click Next.
- On the second screen of the wizard, click Record.
- Build your software project in your regular build
environment.
- On the third screen of the wizard, click Finalize.
- On the fourth screen of the wizard, click Browse Project.
The degree of parallelism in the analysis
will depend on the setting of ANALYSIS_SLAVES.
For more details, see section Building and Analyzing Projects
(Windows).
This is the Analysis page. It
displays information about the CodeSonar analysis of the project. By
default it will show the Warnings tab, which contains a
table with a line of information about each warning generated.
- If the analysis is still running, the Analysis State field will describe the current
state of the analysis. Use your browser's Reload command to refresh the page.
- When the analysis is finished, the Analysis State field will read Finished.
To view a warning report, click anywhere on its entry in the
summary table. A warning report page will open, containing:
- summary information for the CodeSonar analysis of the
project,
- summary information for the warning, and
- a code excerpt with lines of interest highlighted, together
with line numbers and annotations indicating problem conditions
(where present).
For more details, see section Warning Report.