github.com/klaytn/klaytn@v1.12.1/tags-for-todo-and-note.md (about)

     1  # tags for TODO & NOTE
     2  
     3  This document is to collect the existing tags for TODO & NOTE and their descriptions. A Tag here means a word or words used to categorize related comments. (e.g., `TODO-Klaytn-TAG`, `TODO-Klaytn-ServiceChain` ) Before leaving a comment using `TODO` or `NOTE`, please check this document to use proper tag. If a proper tag exists, use it. However, if there is no proper tag, use a new tag and also add it to this document.
     4  
     5  
     6  
     7  ## Why use tags?
     8  
     9  As described above, its primary purpose is to **categorize related comments and issues by tag**. If you want to search for something to do in ServiceChain category, you can just `grep TODO-Klaytn-ServiceChain` to get the list of TODOs in ServiceChain category. Also, by putting `Klaytn` between prefix and tag, **we can distinguish TODOs from geth and Klaytn**. Below are examples of comments using tags.
    10  
    11  ```
    12  // TODO-Klaytn-TAG
    13  // e.g., TODO-Klaytn-ServiceChain Need to add an option, not to write receipts.
    14  // NOTE-Klaytn-TAG
    15  // e.g., NOTE-Klaytn-RemoveLater Below Prove is only used in tests, not in core codes.
    16  ```
    17  
    18  
    19  
    20  ## Prefixes - TODO, NOTE
    21  
    22  - Above prefixes should be used in `PREFIX-Klaytn-TAG` format.
    23  - **TODO**
    24    - When you leave a comment to describe **something needed to be done**.
    25  - **NOTE**
    26    - When you leave a comment to explain **something important to be noticed** by Klaytn developers.
    27    - `NOTE` is not highlighted by GoLand IDE by default, however, [you can change the setting to highlight NOTE keyword.](https://www.jetbrains.com/help/idea/using-todo.html)
    28  
    29  
    30  
    31  ## List of Tags
    32  
    33  Please note that the tag name always
    34  
    35  - **starts with a capital letter**
    36  - **uses camel-case if it has two words or more**.
    37  
    38  | TagName                                        | Description                                               |
    39  | ---------------------------------------------- | --------------------------------------------------------- |
    40  | Issue[IssueNumber], e.g., TODO-Klaytn-Issue833 | If a corresponding issue exists.                          |
    41  | Docs                                           | Documentation or copyright related comments.              |
    42  | BN                                             | Related to BootNode.                                      |
    43  | FailedTest                                     | Tests currently fail on Klaytn. (therefore commented out) |
    44  | RemoveLater                                    | Codes which can be removed later due to some reasons.     |
    45  | FeePayer                                       | Related to FeePayer feature.                              |
    46  | Gas                                            | Related to gas calculation and its policy.                |
    47  | MultiSig                                       | Related to MultiSig feature.                              |
    48  | TestNet                                        | Related to TestNet.                                       |
    49  | NodeDiscovery                                  | Related to NodeDiscovery.                                 |
    50  | Accounts                                       | Related to Klaytn Accounts.                               |
    51  | Downloader                                     | Related to Downloader.                                    |
    52  | NodeCmd                                        | Related to cmd/utils/nodecmd.                             |
    53  | Storage                                        | Related to storage.                                       |
    54  | Refactoring                                    | Related to refactoring.                                   |
    55  | gRPC                                           | Related to gRPC.                                          |
    56  | HF                                             | Related to HardFork.                                      |
    57  | StateDB                                        | Related to StateDB and stateObject.                       |
    58  | DataArchiving                                  | Related to Data Archiving feature.                        |