DEV Community

Discussion on: What are the great function/method/etc. names in popular libs/languages?

Collapse
 
ben profile image
Ben Halpern • Edited

I thought to make this thread based on a conversation I was having in @aspittel 's great clean coding post.

I love React's dangerouslySetInnerHTML which replaces a lot of documentation and comments and forces the user to understand what's going on. If you don't know why it says "dangerous", you can look it up.

Much better than

//This is dangerous, read this post about XSS:
setInnerHTML

Because the comment would never get ported across all the use cases (obviously, given it's a library).

But most code doesn't live up to the scrutiny of library code and comments, used properly, are a perfectly reasonable part of the toolbelt.