Grading Codes

What Do They Mean?

There are several aspects on which all of your programming assignments will be graded. Each aspect is associated with a code, usually 2 letters, but sometimes more. The meaning of the most common ones are explained below.

OUT Output - Your output did not match the expected output. If you only had a very minor discrepency, you may lose as few as one point. If you had no output or all of it was incorrect, you may lose all of the points. A diff tool is always used to verify the output.

FHC File Header Comment - Each program file must include a file header that includes the information specified. This is an example of a file header from CS120. All lines are required:

/*****************************************************************************
filename    foo.cpp
author      Artie Fufkin
DP email    afufkin2@digipen.edu
course      CS170 
assignment  1
due date    9/19/2026

Brief Description:
  This program calculates the distance to the moon using only a compass
  and a straight-edge. Functions include:
  - Distance
  - Calculate
  - Convert
  - Convolve
  - Contort

*****************************************************************************/

Doxygenized version:

/****************************************************************************/
/*!
\file    foo.cpp
\author  Artie Fufkin
\par     DP email: afufkin2@digipen.edu
\par     Course: CS170
\par     Section: A
\par     Assignment: 1
\date    9/19/2026

\brief
  This program calculates the distance to the moon using only a compass
  and a straight-edge. Functions include:
  
  - Distance
  - Calculate
  - Convert
  - Convolve
  - Contort
 
*/
/****************************************************************************/

FNH Function Header Comment - Each function must have a comment describing its purpose, return values (if any), and any input/output parameters. Here's an example from CS120. All lines are required:

/*****************************************************************************
   Function: EDetect
   
Description: Transforms a bitmap picture by darkening the edges that
             were detected by the edge-detect algorithm.

     Inputs: picture    - A pointer to the image that will be transformed.
             resolution - The degree to which the transformation will occur.

    Outputs: The number of processor cycles required by the algorithm.
*****************************************************************************/

Doxygenized version:

/****************************************************************************/
/*!
  \brief   
    Transforms a bitmap picture by darkening the edges that were detected by 
    the edge-detect algorithm.

  \param picture
    A pointer to the image that will be transformed. 
      
  \param resolution
    The degree to which the transformation will occur.

  \return
    The number of processor cycles required by the algorithm.
*/
/****************************************************************************/

ID Internal Documentation - Essentially, these are comments in the code. All code is required to have some documentation in the form of inline comments. Code that has no comments or very few will lose points.
CQ Code Quality - This is simply a gauge of the quality of your code. I posted a link to the Code Quality Guidelines which list some of these items. Not all will be applicable at this time. As we progress, more and more of these should concern you.
DW Doxygen Warnings - Doxygen may emit warnings just like the compiler does. You must not have any Doxygen warnings. Doxygen will be covered during the first couple of weeks.
MEMBUGS Dr. Memory problems - Dr. Memory will detect problems with your code at runtime. These can include things like memory leaks or overwriting the end of an array. Dr. Memory will be covered before you need to worry about this. There is a very similar tool available on Linux called Valgrind. This is what the submission server uses to detect memory problems.