Source Headers

[Killswitch]

I usually start all of my programs with a small header, like this:

Code: Select all

;\\------------------------------
;\\-Name-------------------------
;\\------------------------------

It's not done me any harm, but I'm looking to change to a format that's more descriptive and a little better looking. Any suggestions?

[ts-soft]

Code: Select all

; ________________________________________________
;    Name
; ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯

[milan1612]

Thats what I use...

Code: Select all

;##############################################
;## milan1612 ## milan1612 [at] gmx [dot] de ##
;##############################################

[Demivec]

Code: Select all

;// PureBasic Source File
;// File:  3dGame working 17d.pb
;// Vers:  4.10 beta2
;// Desc:  Action packed 3D-game with multiple levels and perspectives
;// Date:  04/18/2007
;// Auth:  Demivec

The information in the example is hypothetical by the way.

As regarding "style" I think it just needs to catch your attention. The above is given a different format and font because of the ";/" at the beginning (I'm using jaPBe v3.6.5.510). Otherwise take your pick of border punctuation lines (###,:::,---,***,___,!!!,...,<<<,>>>,===,^^^,%%%,+++.\\\.///).

Yea, I know the example is a few fore lines than what you'd typically use but it sure saves the memory when looking at a file.

[Trond]

Why not drop it alltogether?

Apart from that, I always use a space after ; because I think it looks less cramped.