• TheDoctor [they/them]@hexbear.net
    link
    fedilink
    English
    arrow-up
    0
    ·
    2 months ago

    I often use comments as ways to say, “I know this is cursed, but here’s why the obvious solution won’t work.” Like so:

    /**
     * The column on this table is badly named, but
     * renaming it is going to require an audit of our
     * db instances because we used to create them
     * by hand and there are some inconsistencies
     * that referential integrity breaks. This method
     * just does some basic checks and translates the
     * model’s property to be more understandable.
     * See [#27267] for more info.
     */