Software Design
 
Forums: » Register « |  User CP |  Games |  Calendar |  Members |  FAQs |  Sitemap |  Support | 
User Name:
Password:
Remember me
Go Back   Dev Shed ForumsProgramming Languages - MoreSoftware Design

Reply
Add This Thread To:
  Del.icio.us   Digg   Google   Spurl   Blink   Furl   Simpy   Y! MyWeb 
Thread Tools Search this Thread Rate Thread Display Modes
 
Unread Dev Shed Forums Sponsor:
  #1  
Old September 27th, 2004, 08:52 AM
Tryst Tryst is offline
Contributing User
Dev Shed Newbie (0 - 499 posts)
 
Join Date: Oct 2003
Posts: 146 Tryst User rank is Just a Lowly Private (1 - 20 Reputation Level) 
Time spent in forums: 12 h 27 m 38 sec
Reputation Power: 6
Documenting Code

Hi all,

I am in the process of documenting various snippets of code from my application so that I can detail and explain the logic, and was wondering what everyone uses when they insert code into a document (Word for example). I'd like to present my code a bit like it is in Programming publications

Ideally, I am looking for something that presents the code neatly and to a nice size.

Tryst
__________________
Tryst

Reply With Quote
  #2  
Old September 27th, 2004, 01:01 PM
codergeek42's Avatar
codergeek42 codergeek42 is offline
[Insert clever comment here.]
Dev Shed God 2nd Plane (6000 - 6499 posts)
 
Join Date: Jul 2003
Location: Anaheim, CA (USA)
Posts: 6,459 codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)codergeek42 User rank is General 4th Grade (Above 100000 Reputation Level)  Folding Points: 39542 Folding Title: Starter FolderFolding Points: 39542 Folding Title: Starter Folder
Time spent in forums: 1 Month 1 Week 6 Days 21 h 42 m 24 sec
Reputation Power: 1231
Send a message via ICQ to codergeek42 Send a message via AIM to codergeek42 Send a message via Yahoo to codergeek42 Send a message via Google Talk to codergeek42
I tend to use normal fonts (such as 10-pt Bitstream Vera Sans) for paragraphs and other stuff, then smaller, monospaced fonts (like 8-pt Bitstream Vera Sans Mono) for the code.
__________________
~~ Peter ~~
( My Blog: It's exactly like normal nerdiness, but completely different. ) :: ( Supporter of the EFF & FSF ) :: ( I'm a GNU/Linux addict and Free Software Advocate. ) :: ( How to Ask Questions the Smart Way ) :: ( The Fedora Project, sponsored by Red Hat ) :: ( GNOME: The Free Software Desktop Project ) :: ( GnuPG Public Key )

Reply With Quote
  #3  
Old September 29th, 2004, 03:26 AM
medialint's Avatar
medialint medialint is offline
Type Cast Exception
Click here for more information.
 
Join Date: Apr 2004
Location: The Comfy Chair
Posts: 12,928 medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)medialint User rank is General 32nd Grade (Above 100000 Reputation Level)  Folding Points: 260297 Folding Title: Super Ultimate Folder - Level 1Folding Points: 260297 Folding Title: Super Ultimate Folder - Level 1Folding Points: 260297 Folding Title: Super Ultimate Folder - Level 1Folding Points: 260297 Folding Title: Super Ultimate Folder - Level 1Folding Points: 260297 Folding Title: Super Ultimate Folder - Level 1Folding Points: 260297 Folding Title: Super Ultimate Folder - Level 1
Time spent in forums: 5 Months 1 Day 4 h 13 m 22 sec
Reputation Power: 3094
In Word I use Courier New 8pt. Indented, sometimes boxed.

Then I usually make the word an rtf and feed it into a help compiler.
__________________
medialint.com


"Beware of the man who works hard to learn something, learns it, and finds himself no wiser than before. He is full of murderous resentment of people who are ignorant without having come by their ignorance the hard way."
- Vonnegut - Cat's Cradle, 1963

Reply With Quote
Reply

Viewing: Dev Shed ForumsProgramming Languages - MoreSoftware Design > Documenting Code


Thread Tools  Search this Thread 
Search this Thread:

Advanced Search
Display Modes  Rate This Thread 
Rate This Thread:


Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off
View Your Warnings | New Posts | Latest News | Latest Threads | Shoutbox
Forum Jump


Forums: » Register « |  User CP |  Games |  Calendar |  Members |  FAQs |  Sitemap |  Support | 
  
 





© 2003-2008 by Developer Shed. All rights reserved. DS Cluster 3 hosted by Hostway
Stay green...Green IT