- NOTE: \bNOTE\b.* Informacje lub uwagi
- MARK: \bMARK\b.* Wizualne znaczniki sekcji kodu
- REGION: \bREGION\b.* Oznaczenie pseudo-bloków kodu
- OPT: \bOPT\b.* Miejsca do optymalizacji
Często używam w kodzie komentarzy typu // TODO: powód jest prosty bo JetBrains (PyCharm, GoLand itd.) ładnie je podświetla
i pokazuje jako zielone markery po prawej stronie edytora. W ten sposób znaczę sobie podczas pracy z kodem fragmenty kodu.
Problem zaczyna się jednak wtedy, gdy pracuje z GitHubem, lintersami albo CI, które również reagują na TODO: — i robi się bałagan
w review lub testach.
Na szczęście da się to łatwo obejść tworząc własne, kolorowe znaczniki, które działają dokładnie jak TODO, ale pod innymi nazwami,
które nie przeszkadzają już Githubowi. I tu chciałbym wam pokazać jak to osiągnąć.
Krok po kroku – jak dodać własny znacznik
Otwórz:
Settings → Editor → TODO
Kliknij + (Add), aby dodać nowy wzorzec.
W polu Pattern wpisz np.:
\bNOTE\b.*
Dla środowiska oznacza to: - komentarze zaczynające się od // NOTE:
teraz wybieramy własny kolor (np. niebieski) i ewentualnie kolor tła lub effekt
- Klikamy OK.
- Klikamy Apply.
Od teraz można w kodzie pisać:
- // NOTE: Tu będzie nowa logika logowania użytkownika
który pokazuje się w tzw. gutter stripe (ta pionowa kolorowa linia z prawej strony edytora kodu).
Dodatkowo zobaczycie go też w oknie TODO Tool Window, można też po nim filtrować lub wyszukiwać w całym projekcie.
Moje wzorce tagów które używam w kodzie:
Ja osobiście wprowadziłem u siebie kilka tagów , które używam podczas pisania kodu jako znaczniki :
Dlaczego warto skorzystać z tagów ?
-- uzyskujemy czytelne, kolorowe markery w edytorze,
-- unikamy konfliktów z narzędziami CI/CD,
-- możemy dowolnie grupować i oznaczać fragmenty kodu,
działa to we wszystkich IDE JetBrains dodatkowo pomaga w porządkowaniu kodu i ułatwia nanoszenie poprawek.
Od teraz tagi:
// NOTE:
// MARK:
// REGION:
// OPT:
Wszystkie one pojawią się w TODO Tool Window oraz w minimapie po prawej stronie edytora kodu i będą łatwo wyszukiwalne w projekcie.
To takie niewielkie usprawnienie , ale jakże pomocnicze.
dzięki za tipa
