Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Post History

62%
+3 −1
Q&A C naming convention, module trigrams?

Personally, I don't like the first form (initCanDriver) at all. The routine name is supposed to present some information as to where/how the routine fits into the larger software world. Informati...

posted 1y ago by Olin Lathrop‭

Answer
#1: Initial revision by user avatar Olin Lathrop‭ · 2022-09-24T13:40:34Z (over 1 year ago)
Personally, I don't like the first form (initCanDriver) at all.

The routine name is supposed to present some information as to where/how the routine fits into the larger software world.  Information is best presented in global to local context order.  This is because the local information often makes no sense outside of its context hierarchy.

To me, "CanDriverInit" or "CanDriver_init" is much better.  It also has the advantage that all the CAN driver routines will show up in a sorted list next to each other.  That can be useful.

I think the concept behind "CDR_init" is OK, but the implementation is lacking.  Only three letters to indicate the package or library is too cryptic.  In this case, someone seeing just "CDR" won't have much of a guess what the library is about, and there is a significant possibility of a name collision in the future.  "CANDR" would already be much better in my opinion.

I do appreciate the effort to minimize gratuitous typing somewhat.  Long routine names distract the mind to get the name right instead of what the code is supposed to do at that point, and reduce the space for end of line comments.

In the end, it's a judgement call based on how you value the various tradeoffs.  There is no universal right answer.  Personally, I like the "CanDriverXxx" or "CanDriver_xxx" naming schemes, but wouldn't be too opposed to "CANDR_xxx" or "CanDr_xxx".  I'd really not like "CDR_xxx".