2025-02-10

The best code review comment ever

I just wrote a code review comment that I feel particularly smug about.

The code I was reviewing:

class PointClouds ...

My comment:


It is a bad idea to have a type name in plural. If you need to signify plurality, use a plurality-signifying suffix in singular form, as in:

  • PointCloudCollection
  • PointCloudSet
  • PointCloudGroup
  • or go creative with PointCloudFormation
  • or take creativity to a whole new level with PointCumulonimbus

Anything but a plural type name.

 


Cover image created by ChatGpt using the following prompt: "Please give me an illustration conveying the concept of "code review". Make it in landscape format, with clean colors."

2 comments:

  1. I have never heard of Cumulonimbus before but that sounds cool, going to use this for all my classes from now on

    ReplyDelete
  2. (/s) This is a good one! Sound advice in multiple ways 😂

    ReplyDelete