Comment (Programming)

I need to write better comments. My comments for my Poker AI project makes me realize how messy and unclear there are.

  • I write too many comments instead of being clear and concise. TOO VERBOSE. Be concise.

Great comments are short and sweet. Rest of it is self-explained by great code.

I guess I write comments in the process brainstorming.

  • As I clean up my Poker AI code, I’ve removed all of this garbage unnecessary code

Of course, ideally, you just don’t have comments at all as outlined in your MY Programming Style Guide, but usually, some level of comment is pretty helpful.

I’ve realized that when people use this kind of style, it’s much clearer than just plan comments. Because it creates these sort of headers in code.

# ----- SECTION -----
a = b + 2