Project Style Guide

CS 1323 Honors, Fall 1996

Review this guide for each new project.
New requirements emerge as projects increase in complexity.

Project Document Requirements Use 8.5x11 paper, written in portrait orientation. Put your name and the project number at the top of the first sheet. Staple the sheets together in the upper left corner. No green-line paper. No fan-fold paper. No paper clips.

Standards for Haskell Scripts Keep all lines in under 70 characters in length. Indent each succeeding line in a multi-line formula. Break multi-line formulas at operators with low precedence. Align arguments vertically in multi-line argument lists. Use capitalLetters to mark componentWords in compoundEntityNames. Use literate Haskell script format for all of your work. Precede each definition of a function in a script with an explanation of the relationship between the value it delivers and the values of its arguments.

Literate Haskell Scripts All of the lines containing Haskell code begin with a greater-than sign (>). Lines not beginning with this mark are treated as commentary. Commentary lines and code lines must be separated by a blank line. Precede each function in your script with a description of what it delivers in terms of the arguments it is supplied. (Follow the examples in the solution to Individual Project 2. Literate Haskell scripts are stored in files with the extension ".lhs" in their filenames (e.g. matchingElements.lhs).

Type Specifications in Haskell Scripts

Each definition in a Haskell script must be accompanied by a specification giving the type of the entity being defined. For example, if you were defining a function to deliver a sequence consisting of the square, cube, and fourth power of a number of type Float, supplied as and argument, the definition might look like this:
somePowers :: Float -> [Float]
somePowers x = [x*x, x*x*x, x*x*x*x]
Or, if you were defining a variable of type Int, your definition might look like this:
numberOfTerms :: Float
numberOfTerms = 50

Standards for Session Transcripts

Most projects require you to turn in a transcript of a session in which you use Hugs. You generate such a session by issuing the command "script" to Unix before issuing the command "hugs", then pressing "control-D" upon exiting from Hugs.

These actions produce a file named "typescript" containing a transcript of the Hugs session. Such files contain backspace characters, which make the print-out look ugly in spots. Before printing the typescript file, reissue the command "hugs", load the script "removeBS, hs" and issue the command "main" to Hugs. This command will write file named "typescript.cln" in which the backspaces have be interpreted properly. This file contains no unsightly backspaces. Print it instead of the raw transcript file.

Obtain a copy of the Haskell script "removeBS, hs" (and needed support software: SequenceUtilities.lhs and IOutilities.lhs) by following the procedure described in Step 2 of Individual Project 1 for downloading software from the Supplied Software page on the CS1323 Web site.

CS 1323 Section 30 - Fundamentals of Computer Programming - Spring 1997 Instructor: Rex Page (Email: page@ou.edu)
Up to: Welcome Page ~~~ Up to: University of Oklahoma ~~~ Go to: Next Semester ~~~ Go to: Previous Semester
Last Modified: Friday, 02-Dec-2005 11:43:35 CST

Project Style Guide

CS 1323 Honors, Fall 1996

Review this guide for each new project. New requirements emerge as projects increase in complexity.

Project Document Requirements

Standards for Haskell Scripts

Literate Haskell Scripts

Type Specifications in Haskell Scripts

Standards for Session Transcripts

Review this guide for each new project.
New requirements emerge as projects increase in complexity.