Encodo C# Handbook
-
Who are these Encodo guys and why do we have to use their style? Has MS officially endorsed it?
Encodo is a small software consulting company in Switzerland. We published our handbook because it helped us a lot and we figured we could share it with the community. You're free to take or leave whatever you like from it and we welcome any suggestions you might have. We're still waiting on an official MS endorsement. ;-)
modified on Monday, December 1, 2008 2:38 AM
-
Ennis Ray Lynch, Jr. wrote:
There is a special circle of hell for the bigots that write these documents.
Well, to be fair this document is not entirely about style. Some of it is about practice, which is more objective.
Ennis Ray Lynch, Jr. wrote:
The real irony is that style guide is somehow read as style law?
Yes, the operative word should be "guide."
Kevin
As the primary author of the guide, I'll respond to your message instead of the initial troll. I found "special circle of hell for the bigots" to be a bit over the top for a style guide we published free to the community. Take or leave what you like from the guide; it's only text and can't force you to do anything. It's up to an individual organization to determine how they want to enforce a coding style, if at all. We found that having a common coding style improved our code overall; YMMV. We don't, however, enforce it in all cases. The handbook has been much more useful as a place to look for guidance when you don't have a personal opinion on how something should be formatted (e.g. larger case statements or wrapping for long methods). As the document itself states in the first few paragraphs, we were constantly updating it as we went along until we had something that reflected the input of all interested parties. We're still open to suggestions.
-
Modify it so it doesn't have any proprietary stuff and post it as an article. Dare!
We (Encodo) actually tried to post it at CodeProject as an article but where rejected as it is no real Sourcecode-Project. :)
-
As the primary author of the guide, I'll respond to your message instead of the initial troll. I found "special circle of hell for the bigots" to be a bit over the top for a style guide we published free to the community. Take or leave what you like from the guide; it's only text and can't force you to do anything. It's up to an individual organization to determine how they want to enforce a coding style, if at all. We found that having a common coding style improved our code overall; YMMV. We don't, however, enforce it in all cases. The handbook has been much more useful as a place to look for guidance when you don't have a personal opinion on how something should be formatted (e.g. larger case statements or wrapping for long methods). As the document itself states in the first few paragraphs, we were constantly updating it as we went along until we had something that reflected the input of all interested parties. We're still open to suggestions.
mvonballmo wrote:
I'll respond to your message instead of the initial troll. I found "special circle of hell for the bigots" to be a bit over the top for a style guide we published free to the community.
Did you mean to reply to Ennis Ray Lynch instead of me? It was he who made that statement.
mvonballmo wrote:
The handbook has been much more useful as a place to look for guidance when you don't have a personal opinion on how something should be formatted (e.g. larger case statements or wrapping for long methods).
Yes, I found it useful in this way. I will certainly be making use of much of your guidance going forward if and when I am free to do so. (I've not worked since seeing your guide, so haven't had the chance to apply it yet. :( )
Kevin
-
mvonballmo wrote:
I'll respond to your message instead of the initial troll. I found "special circle of hell for the bigots" to be a bit over the top for a style guide we published free to the community.
Did you mean to reply to Ennis Ray Lynch instead of me? It was he who made that statement.
mvonballmo wrote:
The handbook has been much more useful as a place to look for guidance when you don't have a personal opinion on how something should be formatted (e.g. larger case statements or wrapping for long methods).
Yes, I found it useful in this way. I will certainly be making use of much of your guidance going forward if and when I am free to do so. (I've not worked since seeing your guide, so haven't had the chance to apply it yet. :( )
Kevin
I actually phrased that badly; what I meant was that I wanted to add to your response instead of responding directly to Ennis Ray. Thanks for the kinds words and I hope you find work!