Apple-2-SW/a2d
1
0
Fork 0
mirror of https://github.com/mi57730/a2d.git synced 2025-08-09 01:24:57 +00:00
Code Issues Projects Releases Wiki Activity

Coding style: note about questions

Browse Source
This commit is contained in:
Joshua Bell
2018-03-27 18:19:33 -07:00
committed by GitHub
parent 7e483c3ef5
commit feacc900d2
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
CodingStyle.md
View File

@@ -24,7 +24,14 @@ syntax details.
* End-of-line comments: `;` at a tab stop or aligned with nearby code * End-of-line comments: `;` at a tab stop or aligned with nearby code
* Indented stand-alone comments: `;;` at first tab stop (8 chars) * Indented stand-alone comments: `;;` at first tab stop (8 chars)
* Major comments: `;;;` at start of line * Major comments: `;;;` at start of line
* Use `?` for questions in comment text, `???` for questions about the code:
```asm
lda value
cmp #limit ; less than the limit?
bcc less ; yes, so go do that
rol $1234 ; what does this do ???
```
## Naming ## Naming
@@ -42,7 +49,7 @@ cases, e.g. `HideCursor`, `HideCursorImpl`, etc.
* **Do** make use of [unnamed labels](http://cc65.github.io/doc/ca65.html#ss6.6) for * **Do** make use of [unnamed labels](http://cc65.github.io/doc/ca65.html#ss6.6) for
local loops and forward branches to avoid pointless names. Only use one level. local loops and forward branches to avoid pointless names. Only use one level.
``` ```asm
;; Copy the thing ;; Copy the thing
ldy #7 ldy #7
: lda (src),y : lda (src),y
@@ -72,7 +79,7 @@ cases, e.g. `HideCursor`, `HideCursorImpl`, etc.
* Delimit code blocks with `.proc`: * Delimit code blocks with `.proc`:
``` ```asm
.proc some_routine .proc some_routine
lda $06 lda $06
rol rol
@@ -82,7 +89,7 @@ cases, e.g. `HideCursor`, `HideCursorImpl`, etc.
* Try to encapssulate locally used data as much as possible. * Try to encapssulate locally used data as much as possible.
``` ```asm
.proc some_routine .proc some_routine
ptr := $06 ptr := $06
lda ptr lda ptr
@@ -95,7 +102,7 @@ stash: .byte 0
* Use `impl` if the entry point is not at the start: * Use `impl` if the entry point is not at the start:
``` ```asm
.proc some_routine_impl .proc some_routine_impl
stash: .byte 0 stash: .byte 0
@@ -124,7 +131,7 @@ Parameter blocks are used for ProDOS MLI calls and MGTK calls.
* Wrap param data in `.proc` blocks: * Wrap param data in `.proc` blocks:
``` ```asm
.proc textwidth_params .proc textwidth_params
textptr: .addr text_buffer textptr: .addr text_buffer
textlen: .byte 0 textlen: .byte 0
@@ -146,13 +153,13 @@ well in the future.
* Add a label for the value being modified (byte or address) * Add a label for the value being modified (byte or address)
``` ```asm
sta jump_addr sta jump_addr
stx jump_addr+1 stx jump_addr+1
jump_addr := *+1 jump_addr := *+1
jmp $0000 jmp $0000
``` ```
``` ```asm
sty count sty count
ldy #0 ldy #0
: sta table,y : sta table,y