Group Actions
Engagement
  • Author Author: Jan Cumps
  • Date Created: Date Created
  • Views 914 views
  • Likes 4 likes
  • Comments 7 comments
Related
Recommended

sensible C++ coding convention - µOS naming standard

Jan Cumps

When writing reusable code, I like to be consistent and use standards. For C++, there are many flavours out there.

I've been looking around for guidance on writing modern C++ code, with templates. That's when I bumped into the µOS naming standards. µOS is a C++ RTOS, maintained by Liviu Ionescu. He 's been very active on this community for a long time, when this forum was used to support the Eclipse Embedded CDT plugin.

He managed to compile a reasonable naming convention set. Pragmatic, not pedantic.
A number of naming proposals try to cover all, or are detailed. I like a standard that handles the conceptual level. To my taste, the µOS standard has a good balance.
It's more brief than many other options out there, but I haven't found a miss. And I like how my code "sounds" when applying the principles.

When writing code, check it out. I've recently designed a C++ library, that (I hope) adheres to that standard. It helps me to stay consistent, and I hope it helps the user to understand my library's API.

that's all :)

Link to related posts.

Parents

  • Thanks Jan.

    Naming conventions are always a good way to start a fight among software engineers. 

    While most people don't care, they just want to get the code done, you always run into a few fanatics who have their favorite and refuse to conform.

    If you are just writing code for yourself you can do what you want, but as soon as you work with a team, you need everyone on board or chaos ensues.

Comment

  • Thanks Jan.

    Naming conventions are always a good way to start a fight among software engineers. 

    While most people don't care, they just want to get the code done, you always run into a few fanatics who have their favorite and refuse to conform.

    If you are just writing code for yourself you can do what you want, but as soon as you work with a team, you need everyone on board or chaos ensues.

Children
  • in reply to DAB

    I found that in my latest project, when I wrote some core code and two separate support libraries, the style lacked consistency. I used some C++ constructs that are new to me.

    The standard that I'm referring to, is very similar to the standard C++ libraries style (author: what the ISO standard libraries use, and to what existing coding styles [like MISRA, JSF] recommend). Maybe a bit simpler and more pragmatic. Sized for user code.

    Not all of it is what I prefer. But it is reasonable. That's why I selected this.

    In the past, I used the standards proposed by the Industrial Strength C++ book, but that hasn't had an update since early C++ (1997).