[General Design] Commenting Help

coelurus · Post by **coelurus** » Fri 01 Apr, 2005 4:09 pm

What's that, "baloney"?

EDIT: Aha, quite the opposite

CoBB · Post by **CoBB** » Fri 01 Apr, 2005 4:41 pm

Google tells you instead of me.

Post by **kv83** » Fri 01 Apr, 2005 7:18 pm

Crimson Editor is defently the best to do... just look:

(I like the 'one-button-compile' option

and the z80 syntax highlight... it just makes it more easier to read )

If you want to comment in a better way, try to comment in blocks

Code: Select all

lblShuffleLoop:	
	;--   Copy current card position to de   --
	push hl
	push de
	ld d,h
	ld e,l
	;------------------------------------------

This block for example copies the current card position to de (quite obvious out of my comment system). Comment source line by line isn't a good idea in ASM! Just comment for a whole block

Another thing which is important. Before writing the code, make the comment block. What is the next step which has to be done. After that you exactly know what that block has to do, and if you optimize, it still has to do the same task

Btw: This is more suitable in programming help. Therefor moved

Gambit · Post by **Gambit** » Fri 01 Apr, 2005 7:30 pm

You don't even need to specify what program to compile: Crimson Editor can do that for you

My options are "Compile Z80 Program" (for files in my Asm/(Tasm/Source/Programs) directory) and "Compile Z80 Program Dir" (for files not in my Asm dir (for projects)).

/edit: Here is my commenting style- put big comments for subroutines:

Code: Select all

Label:
;---------------------------------------(block enough to fill up a printed page)
; Inputs:
;   reg - description
;   (addr) - descripton
; Outputs:
;   same structure as inputs
; Destroys:
;   whatever (I also include what is destroyed in any subroutines it calls)
; Put comments here
;---------------------------------------

Sometimes, I don't put those "block" things, but it still makes sense.

DJ_O · Post by **DJ_O** » Fri 01 Apr, 2005 8:10 pm

I havent readed the whole thread but Maybe you could try Timendus commenter

Post by **kv83** » Fri 01 Apr, 2005 9:34 pm

Kevin wrote:I havent readed the whole thread but Maybe you could try Timendus commenter

how about this?

http://calcwebzine.com/private/index.php (use the new routine option)

Timendus · Post by **Timendus** » Fri 01 Apr, 2005 10:01 pm

Oh, yeah... kv, we needed to talk about that