srcanaapps/codescannerextn/com.nokia.carbide.cpp.codescanner/html/overview_cs.htm
Committing the CodeScanner carbide extension.
This component has been moved from the IDE package. BUG : 5889 (http://developer.symbian.org/webbugs/show_bug.cgi?id=5889).
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head>
<title>CodeScanner Overview</title>
<link rel="StyleSheet" href="../book.css" type="text/css"/>
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
</head>
<body>
<div class="Head1">
<h2>CodeScanner Overview </h2>
</div>
<p>CodeScanner is a static source code analysis tool for Symbian OS™ programs written in C++. </p>
<p>Static analysis tools delve deep into code, exploring line by line for the sources of defects. CodeScanner is specifically for use with Symbian OS™ code. As well as identifying C++ coding convention deviations, CodeScanner identifies incorrect descriptor usage, cleanup stack errors, UID clashes, and other subtle problems that are hard to track down. </p>
<p>There are two versions of CodeScanner: </p>
<ul>
<li><strong>CodeScanner IDE</strong> - a plug-in version that integrates with Carbide.c++. This version of CodeScanner provides direct access to the code. Scans can be run through entire projects for all issues; that is, errors, warnings, and non-critical information such as non-adherence to coding conventions.</li>
<li><strong>CodeScanner command-line</strong> - a command line version that integrates into a build system. This version provides statistical summaries of the results of the scan, which are ideal for checking the quality of code submissions.</li>
</ul>
<p>Using CodeScanner can bring the following benefits to your code and to the development process. </p>
<ul>
<li>Finding defects - CodeScanner detects defects directly at the coding stage. Simple but common code defects are found automatically and therefore can be fixed at an early stage. Using CodeScanner reduces the testing, triage, and developer investigation effort in the later stages of development</li>
<li>Finding obscure defects - CodeScanner can find defects that are intermittent, for example, those that might only occur in low memory conditions. These are difficult to find using conventional testing methods</li>
<li>Finding deviations from coding convention - detecting deviations from coding conventions facilitates code maintenance and improves the overall quality of code</li>
<li>Focusing development - cleaning up defects early allows developers to concentrate code reviews on vital design and architectural issues rather than on the more mundane issues, such as badly–named variables, for example</li>
<li>Defining quality levels - using CodeScanner, build managers can use CodeScanner output to determine submission acceptance</li>
<li>Educating developers - developers new to Symbian OS™ (or indeed C++) programming gain instant feedback on their code; learning common pitfalls and idioms in the process</li>
<li>Scan for SDK Specific Porting Issues - CodeScanner can scan your code and detect areas that require modification when porting your application to a new SDK, such as a new touch screen user interface SDK. Porting information and links to additional porting information will be provided as appropriate in the Problems or Console view and context menus. To show information markers in the Problems view make sure that <strong>Show > Show All</strong> is selected in the View Menu (upside down triangle icon) in the Problems view.</li>
</ul>
<div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
</body>
</html>