core/com.nokia.carbide.cpp.codescanner/html/overview_cs.htm
author fturovic <frank.turovich@nokia.com>
Tue, 07 Apr 2009 13:55:47 -0500
branchRCL_2_0
changeset 69 cab50ba61335
parent 2 d760517a8095
permissions -rw-r--r--
added info on IAD custom rules
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
cawthron
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head>
cawthron
parents:
diff changeset
     2
<title>CodeScanner Overview</title>
cawthron
parents:
diff changeset
     3
<link rel="StyleSheet" href="../book.css" type="text/css"/>
cawthron
parents:
diff changeset
     4
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
cawthron
parents:
diff changeset
     5
</head>
cawthron
parents:
diff changeset
     6
   <body>
cawthron
parents:
diff changeset
     7
   <div class="Head1">
cawthron
parents:
diff changeset
     8
<h2>CodeScanner Overview </h2>
cawthron
parents:
diff changeset
     9
</div>
cawthron
parents:
diff changeset
    10
   <p>CodeScanner is a static source code analysis tool for Symbian OS&trade; programs written in C++. </p>
cawthron
parents:
diff changeset
    11
   <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&trade; 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>
cawthron
parents:
diff changeset
    12
   <p>There are two versions of CodeScanner: </p>
cawthron
parents:
diff changeset
    13
   <ul>
cawthron
parents:
diff changeset
    14
     <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>
cawthron
parents:
diff changeset
    15
     <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>
cawthron
parents:
diff changeset
    16
   </ul>
cawthron
parents:
diff changeset
    17
   <p>Using CodeScanner can bring the following benefits to your code and to the development  process. </p>
cawthron
parents:
diff changeset
    18
   <ul>
cawthron
parents:
diff changeset
    19
     <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>
cawthron
parents:
diff changeset
    20
     <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>
cawthron
parents:
diff changeset
    21
     <li>Finding deviations from coding convention - detecting deviations from coding conventions  facilitates code maintenance and improves the overall quality of code</li>
cawthron
parents:
diff changeset
    22
     <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&ndash;named variables, for example</li>
cawthron
parents:
diff changeset
    23
     <li>Defining quality levels - using CodeScanner, build managers can use CodeScanner  output to determine submission acceptance</li>
cawthron
parents:
diff changeset
    24
     <li>Educating developers - developers new to Symbian OS&trade; (or indeed C++) programming  gain instant feedback on their code; learning common pitfalls and idioms in the process</li>
cawthron
parents:
diff changeset
    25
     <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 &gt; Show All</strong> is selected in the View Menu (upside down triangle icon) in the Problems view.</li>
cawthron
parents:
diff changeset
    26
   </ul>
cawthron
parents:
diff changeset
    27
   <div id="footer">Copyright &copy; 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>
cawthron
parents:
diff changeset
    28
   </body>
cawthron
parents:
diff changeset
    29
   </html>
cawthron
parents:
diff changeset
    30