Perl::C...Comments(3)

📦
version 1.14 · 2 versions
, in fedora 43

NAME ✨

Perl::Critic::Policy::Bangs::ProhibitFlagComments — bestie, this one is literally telling you: don't use XXX, TODO, or FIXME. No cap. 💅

So yeah, we're looking at Perl::C...Comments(3) here, and it's part of the user-contributed Perl documentation situation — and it's giving "policy that will absolutely catch you leaving a sad little TODO in your code at 3am". 🫶

AFFILIATION 🎀

This Policy is part of the Perl::Critic::Bangs distribution. That's the whole thing. It lives there. That's its home. 🏠✨

DESCRIPTION 🦋

Okay so picture this: programmers — every single one of them, no exceptions — will leave themselves lil notes in the comments like little breadcrumbs for future them. Future them never reads them. Ever. 😭

This policy goes looking through your comments for any of these three keywords:

  • 'XXX'
  • 'TODO'
  • 'FIXME'

And if it finds them? It has opinions. That's it, that's the policy. It's the vibe check for your unfinished business. 🔥

CONFIGURATION 🌸

By default — like, out of the box, no setup needed — this policy only looks for 'XXX', 'TODO', or 'FIXME' in your comments. That's the starting lineup. 💖

But listen, you can absolutely override that. You just set a value for "keywords" in your .perlcriticrc file, like this:

[Bangs::ProhibitFlagComments]
keywords = XXX TODO FIXME BUG REVIEW

See how that works? Now BUG and REVIEW are in the mix too. Customize it, make it yours, it's your world bestie. ✨

AUTHOR 👑

Andrew Moore <amoore@mooresystems.com>

ACKNOWLEDGMENTS 🫶

This one got adapted from policies by Jeffrey Ryan Thalhammer <thaljef@cpan.org>, and it's based on App::Fluff by Andy Lester, <andy at petdance.com>. Credit where credit is due, periodt. 💐

Copyright (c) 2006-2024 Andy Lester <andy@petdance.com> and Andrew Moore <amoore@mooresystems.com>.

This library is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0. Slay. ✨

okay that's the whole page bestie, go forth and delete your TODOs before the policy finds them 💀

Perl v5.42.0 · dated 2025-07-25 · page Perl::C...Comments(3) — mwah, bye!! 🎀💖🌈

📦 where this page comes from