Dream.In.Code > Programming Help > C and C++

Welcome to Dream.In.Code
	Getting C++ Help is Easy! Join 132,334 C++ Programmers for FREE! Get instant access to thousands of C++ experts, tutorials, code snippets, and more! There are 1,121 people online right now. Registration is fast and FREE... Join Now! Chat LIVE With a C++ Expert

bit of a weird one but ill give it a go

Reply to this topic

Start new topic

bit of a weird one but ill give it a go

didgy58	17 Feb, 2008 - 01:36 AM Post #1
D.I.C Head Joined: 23 Oct, 2007 Posts: 170 Thanked 1 times My Contributions	hey guys im writing up a report for my c++ application and my tutor has told me to produce some documentation/ section of the report containing the class definition and stuff about it, he said to take a look on the internet for styles of writing this correctly but i cant seem to find anything of how to produce this, has anybody ever written a report containing this type of thing if so does anybody have any hints or ideas or maybe even some links on how i should structure this chapter of the report?? thanks dan
	This Post Was Helpful! ^New!


Register for Free to Make These Ads Go Away!

KYA	17 Feb, 2008 - 01:39 AM Post #2
#include <nerd.h> Joined: 14 Sep, 2007 Posts: 4,205 Thanked 50 times Dream Kudos: 1150 My Contributions	Well the general idea is documentation. Say for example someone is taking over your code for maintanence. What would you tell them about it? Any pecularities (sic)? This type of information would be enclosed in such a document. Off the top of my head I would include the purpose of the code, how it is used in relation to other framework, and parameters passed to and fro. Is this too general?
	This Post Was Helpful! ^New!

didgy58	17 Feb, 2008 - 01:44 AM Post #3
D.I.C Head Joined: 23 Oct, 2007 Posts: 170 Thanked 1 times My Contributions	no thats great thanks, at least its giving me a starting point of things to include very thankful for the quick response very much appreciated. thanks again dan.
	This Post Was Helpful! ^New!

KYA	17 Feb, 2008 - 01:56 AM Post #4
#include <nerd.h> Joined: 14 Sep, 2007 Posts: 4,205 Thanked 50 times Dream Kudos: 1150 My Contributions	Anytime. I'm in a technical writing class currently and there many ways you can 'structure' your report; just depends on how anal your teacher is
	This Post Was Helpful! ^New!

Reply to this topic

Start new topic

Display Mode: Standard · Switch to: Linear+ · Switch to: Outline

Track this topic · Email this topic · Print this topic · Subscribe to this forum

Time is now: 11/22/08 03:23AM

Invision Power Board v2.1.7 © 2008 IPS, Inc.

Licensed to: MediaGroup1

Advertising | Terms of Use | Privacy Policy | About Us | Site Map

Forum Index: Programming Help | C and C++ | Visual Basic | Java | VB.NET | C# | ASP.NET | PHP | ColdFusion | Perl and Python | Ruby | Databases | Other Languages | Game Programming | Software Development | Computer Science | Industry News | Programming Tutorials | C++ Tutorials | Visual Basic Tutorials | Java Tutorials | VB.NET Tutorials | C# Tutorials | PHP Tutorials | Linux Tutorials | ColdFusion Tutorials | Windows Tutorials | HTML/JavaScript Tutorials | CSS Tutorials | Flash Tutorials | Web Promotion Tutorials | Photoshop Tutorials | Software Development Tutorials | Database Tutorials | Other Language Tutorials |

Copyright 2001-2008 MediaGroup1 LLC, All Rights Reserved
A MediaGroup1 LLC Production - Version 6.0.2.1.36

Search^Updated!w00t

Over 509,000 Pages! Advanced Forum Search

Live C++ Help!

C++ Tutorials

Reference Sheets

C++ Snippets

Bye Bye Ads

Free DIC T-Shirt

T-Shirt Example

Related Sites

Monthly Drawing

Partners

Top Contributors

Top 10 Kudos This Month