Report File (report.txt) and Grading Tags

Report File

At the top of your report.txt file, you may see lines such as these: 
************************************************************
Failed tests
************************************************************
testXX:     This test failed. XX is a test number between 01 and 99.
doxygen:    Doxygen warnings
doxyheader: Incorrect or missing Doxygen file header comment in the .h file
doxycpp:    Incorrect or missing Doxygen file header comment in the .cpp file
memleak:    Memory leaks
membugs:    Other memory bugs like reading/writing invalid memory, incorrect use of new/delete, etc.
saferun:    Program crashed for various reasons
tablen:     Code has long lines and/or tabs
  Failure deductions: Total amount of points lost for these problems.
This gives you a breakdown of the things that are problematic with your code. These are only the automated tests. The TAs will check for Style Guide and other code quality issues. There may be additional criteria used to grade your programs (e.g. proper use of const), depending on the specific assignment.

For example, a real one looks like this: 

************************************************************
Failed tests
************************************************************
test01: FAILED (-10)
test03: FAILED (-25)
test05: FAILED (-10)
memleak: FAILED (-15)
membugs: FAILED (-15)
tablen: FAILED (-10)
doxygen: FAILED (-10)
  Failure deductions: -95

This program has failed 7 test(s) for various reasons. Some
of the failures may be due to incorrect output, taking too
long to run, memory bugs and/or leaks, or other possible
reasons. The remainder of this document shows the kinds of
problems that were encountered.
The rest of the file gives more details on each of the above problems.

Grading Tags

Since we're not going to be dealing with hard copies anymore, here's an example of the additional lines you need to add to your File Header Comments in your .cpp files (CS 170 and higher).

Make sure you add the lines in BLUE even if you didn't have any problems. If you had no problems, just write NONE. (CS 170 and higher) 

/******************************************************************************/
/*!
\file   foobar.cpp
\author Master Shake
\par    email: master.shake\@digipen.edu
\par    DigiPen login: shakemaster
\par    Course: CS499
\par    Assignment #9
\date   2/19/2019
\brief  
    This file contains the implementation of the following functions for the 
    FooBar class:
      
    Public Operations include:
        Constructor
        Destructor
        blah, blah, blah,
        yada, yada, yada,
    
        other stuff here....
    
    
  Hours spent on this assignment: 

  Specific portions that gave you the most trouble: 

  
*/
/******************************************************************************/
Also, now that there are no hardcopies on which the graders write feedback, this information will be added in a comment to the top of one of the source files. This will usually be the .cpp file.
$CRASH: The program crashed or threw an unexpected exception
$CQ: Code Quality (Style Guide, etc.)
$CW: Compiler Warnings (Unused now that the submission server rejects code that doesn't compile cleanly.)
$DOXYWARN: Misc. Doxygen Warnings. Other related warnings:
  • doxycpp - No Doxygen file header comment (or incorrect) for the .cpp file.
  • doxyheader - No Doxygen file header comment (or incorrect) for the .h file.
$FHC: File Header Comments are deficient
$FNC: Function Header Comments are deficient
$HANG: The program was way too slow or in an infinite loop.
$ID: Internal Documentation (comments)
$LEAK: Memory leaks
$MEMBUGS: Dr. Memory or Valgrind problems (buffer overruns, bad pointer arithmetic, etc.)
$NC: No Compile (errors, Unused now that the submission server rejects code that doesn't compile cleanly.)
$OUT: Output problems (failed tests)
$TABLEN: Tablen problems
$OTHER: Other problems
$EC: Extra Credit
$SCORE: Your score on the assignment
$OUTOF: How much the assignment was worth.
$HOURS: Hours spent working on the assignment.
$ISSUES: Any problems or issues encountered by the student.
$COMMENTS: Comments and suggestions from the graders.

Here's an example: 
/*******************************************************************************
//<<

   $CRASH: -10 (Stress)
      $CQ: -5 (Too much copy/paste)
      $CW: 
$DOXYWARN: -10
     $FHC: -5 (Missing)
     $FNC: 
    $HANG: 
      $ID: 
    $LEAK: 
 $MEMBUGS: 
      $NC: 
     $OUT: -8 (Test1, Test5)
  $TABLEN: -10
   $OTHER: 
      $EC: 

   $SCORE: 72
   $OUTOF: 120

   $HOURS: 6
  $ISSUES: This assignment was easy. 

$COMMENTS:
     - find, remove, and insert are about 80% the same. Make helper functions.
     - Your out-of-bounds checking was incorrect, causing you to fail 2 tests.

>>//
*******************************************************************************/