Comment by WalterBright

9 months ago

One method of commenting that has paid off for me the most was inserting links to:

1. the online documentation of the function being called

2. the instruction documentation for an instruction being generated, inserting

3. the issue that the code fixes

4. the specification of what the function is trying to implement

Then I fixed my text editor to enable click on those links.

2 comments

WalterBright

I also fixed the disassembler to also add a clickable link to the instruction spec page for each instruction.

wglb 9 months ago

I did that back in the day (before we could click on anything) about what the compiler was thinking as it generated the code. That was fun.