comments_guide
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
comments_guide [2025/01/21 16:55] serradfh created |
comments_guide [2025/01/21 17:00] (current) serradfh |
||
|---|---|---|---|
| Line 6: | Line 6: | ||
| ----- | ----- | ||
| - | =====1 - The first line of comment is always the following===== | + | **1 - The first line of comment is always the following** |
| <code>// TODO</code> | <code>// TODO</code> | ||
| Line 12: | Line 12: | ||
| ----- | ----- | ||
| - | =====2- To continue to create the issue of step 1, keep using // in the next lines without real code of the class===== | + | **2- To continue to create the issue of step 1, keep using // in the next lines without real code of the class** |
| ==Correct== | ==Correct== | ||
| Line 28: | Line 28: | ||
| </code> | </code> | ||
| ----- | ----- | ||
| - | =====3 - Issues are created by files, so different "// TODO" in same file and SEPARATED by at least ONE LINE REAL OF CODE will be in the same issue but different section===== | + | **3 - Issues are created by files, so different "// TODO" in same file and SEPARATED by at least ONE LINE REAL OF CODE will be in the same issue but different section** |
| Line 62: | Line 62: | ||
| </code> | </code> | ||
| - | ====Next steps are optional but highly encouraged to give the issues FAST DESCRIPTION and a precise TITLE==== | + | //**Next steps are optional but highly encouraged to give the issues FAST DESCRIPTION and a precise TITLE**// |
| - | =====4- To generate extra information to make a precise tittle and description, inside any TODO, you can add certain codes in the middle of the comment to create context to the issue reader===== | + | **4- To generate extra information to make a precise tittle and description, inside any TODO, you can add certain codes in the middle of the comment to create context to the issue reader** |
| ==Example 1== | ==Example 1== | ||
| Line 86: | Line 86: | ||
| </code> | </code> | ||
| ------ | ------ | ||
| - | =====5- Following are all the ID's for these codes, what they mean and how to use respectively===== | + | **5- Following are all the ID's for these codes, what they mean and how to use respectively** |
| ==If the ID code has a @#END_, any text in the middle of the start and the @#END_, will be used in the description== | ==If the ID code has a @#END_, any text in the middle of the start and the @#END_, will be used in the description== | ||
| Line 137: | Line 137: | ||
| =="Need to add a test case: 'description of test case'"== | =="Need to add a test case: 'description of test case'"== | ||
| <code>@#ADD_TEST description of test case @#END_TEST</code> | <code>@#ADD_TEST description of test case @#END_TEST</code> | ||
| - | + | =====Sample of working comments===== | |
| - | ====Following is a link of a sample of a issue generated using step 5==== | + | **Following is a link of a sample of a issue generated using step 5** |
| [[https://github.com/agadfs/Git_PTIDEJ_Issue_Organizer/issues/121|Sample issue]] | [[https://github.com/agadfs/Git_PTIDEJ_Issue_Organizer/issues/121|Sample issue]] | ||
| =====Known bugs===== | =====Known bugs===== | ||
comments_guide.1737478530.txt.gz · Last modified: 2025/01/21 16:55 by serradfh
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
