Skip to content

Instantly share code, notes, and snippets.

@morozow

morozow/comments.md

Created June 23, 2021 17:09
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save morozow/8deb3698cec8c24c63fe74a529524917 to your computer and use it in GitHub Desktop.
Save morozow/8deb3698cec8c24c63fe74a529524917 to your computer and use it in GitHub Desktop.
Download ZIP
Development comments management
Raw
comments.md

Development comments management

  • IDE
    • The list of development comments
      • @cons: consider
      • @tech: technical
      • @todo: improve
      • @note: information
      • @important: note/remember/consider/etc. the important part of the code
      • @req[XX]: request the information from a colleague "XName XSurname"
    • Tune the JetBrains IDE:
      • Settings/Preferences -> Editor | TODO
      • Create new pattern: Patterns -> Add
        • @cons:
          • Pattern: @cons:
          • Case Sensitive: true
          • Use color scheme TODO default colors: false
          • Foreground: #C0006D
        • @tech:
          • Pattern: @tech:
          • Case Sensitive: true
          • Use color scheme TODO default colors: false
          • Foreground: #4686C0
        • @todo:
          • Pattern: @todo:
          • Case Sensitive: true
          • Use color scheme TODO default colors: false
          • Foreground: #A8C023
        • @note:
          • Pattern: @note:
          • Case Sensitive: true
          • Use color scheme TODO default colors: false
          • Foreground: #00C07F
        • @important:
          • Pattern: @important:
          • Case Sensitive: true
          • Use color scheme TODO default colors: false
          • Foreground: #EF0022
        • @req[XX]:
          • Pattern: @req[\w{0,3}]:
          • Case Sensitive: true
          • Use color scheme TODO default colors: false
          • Foreground: #C096AC
    • Comment
      • The possibility of development comments composition exists.
        • @cons:@tech:@important: DTO Enum Mappers
        • @tech:@todo: State Management
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment