Revert "docs: Move MD files to wiki/ subdirectory"
This reverts commit a369a36a01.
This commit is contained in:
51
9tK-Comments.md
Normal file
51
9tK-Comments.md
Normal file
@@ -0,0 +1,51 @@
|
||||
9tK-Comments.md
|
||||
|
||||
9tailedKitsune comes with 3 types of comments that will found through out.
|
||||
All comment types will have a __**Hashtag**__ followed by another unique symbol at the beginning,
|
||||
Each comment type has its own color, making it easier to tell which comment is which.
|
||||
The 3 types of comments are as follows...
|
||||
## Comment Index
|
||||
- **Major Issues**,
|
||||
- Color: RED
|
||||
-# For Major System Breaking Issues & Comments.
|
||||
- Open: `.#`
|
||||
- Close: `#.`
|
||||
- **Minor Issues**(y),
|
||||
- Color: YELLOW
|
||||
-# For Minor System Non Breaking Issues & Comments.
|
||||
- Open: `#?`
|
||||
- Close: `?#`
|
||||
- **Green Light**(g)
|
||||
- Color: Green
|
||||
-# For Mostly Informational Needs or No issues
|
||||
- Open: `#+`
|
||||
- Close: `+#`
|
||||
|
||||
## Usage Example
|
||||
|
||||
### Major Issues -or- Comments
|
||||
```
|
||||
.# Comment test #.
|
||||
.# this is an example #.
|
||||
.# of how to use Minor #.
|
||||
.# comments in 9tK! #.
|
||||
```
|
||||
### Minor Issues -or- Comments
|
||||
```
|
||||
#?
|
||||
Comment test
|
||||
this is
|
||||
an example
|
||||
of how to
|
||||
use Minor
|
||||
comments
|
||||
in 9tK!
|
||||
?#
|
||||
```
|
||||
### Non Issue -or- Comments
|
||||
```
|
||||
#+ Comment test +#
|
||||
#+ this is an example +#
|
||||
#+ of how to use Minor +#
|
||||
#+ comments in 9tK! +#
|
||||
```
|
||||
Reference in New Issue
Block a user