diff options
| author | mid-kid <esteve.varela@gmail.com> | 2020-06-20 22:55:02 +0000 |
|---|---|---|
| committer | mid-kid <esteve.varela@gmail.com> | 2020-06-20 22:55:02 +0000 |
| commit | f6519b58b337c9ddbff7acb6b16b072d8228495d (patch) | |
| tree | 1f40b090710473a97945c5620249f6cd58ae3462 | |
| parent | 07031949d43efe23a710c1bacc46c1f1b2bb1710 (diff) | |
Updated Code cleanup (markdown)
| -rw-r--r-- | Code-cleanup.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/Code-cleanup.md b/Code-cleanup.md index 274fa7e..0094309 100644 --- a/Code-cleanup.md +++ b/Code-cleanup.md @@ -68,7 +68,10 @@ The convention that should be used is as follows: Namely determining the purpose of them and when they should be defined. -### Unused/Unreferenced +### Unused/Unreferenced/Stubs -- `unused` is a keyword that may be used to denote code or data that is referenced but never used, through branches that are never taken during normal gameplay -- `unreferenced` is a keyword that's used to denote code or data that's never references, thus can never be used, even with glitches, short of ACE. +Currently, a mixture of `UnusedFunction`, `Unreferenced_Function` and `StubbedFunction` is being used. This should be changed, where appropriate names can be given, to comments right after the label in question, meaning the following: + +- `unused` for code or data that is referenced but never used, through branches that are never taken during normal gameplay +- `unreferenced` for code or data that's never referenced, thus can never be used, even with glitches, short of arbitrary code execution +- `stub` for functions that were supposed to do something but don't, because their functionality was removed
\ No newline at end of file |