Encodo C# Handbook
-
There is a special circle of hell for the bigots that write these documents. There, I said it, flame me if you wish. I will be busy writing good code that doesn't conform. BTW, to admit hypocrisy, I once wrote a style guide. It was only two pages long, incorporated everything, and would have fixed 90% (I am not exaggerating) of the problems on the project it was written for, and was flexible enough, to gasp, accommodate people. The reason it was rejected was not because of content, the content was approved and lauded. It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice. The real irony is that style guide is somehow read as style law?
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.Post it!
-
There is a special circle of hell for the bigots that write these documents. There, I said it, flame me if you wish. I will be busy writing good code that doesn't conform. BTW, to admit hypocrisy, I once wrote a style guide. It was only two pages long, incorporated everything, and would have fixed 90% (I am not exaggerating) of the problems on the project it was written for, and was flexible enough, to gasp, accommodate people. The reason it was rejected was not because of content, the content was approved and lauded. It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice. The real irony is that style guide is somehow read as style law?
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.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
-
There is a special circle of hell for the bigots that write these documents. There, I said it, flame me if you wish. I will be busy writing good code that doesn't conform. BTW, to admit hypocrisy, I once wrote a style guide. It was only two pages long, incorporated everything, and would have fixed 90% (I am not exaggerating) of the problems on the project it was written for, and was flexible enough, to gasp, accommodate people. The reason it was rejected was not because of content, the content was approved and lauded. It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice. The real irony is that style guide is somehow read as style law?
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.I second what PIEBALDconsult said. Post it.
Simon
-
Post it!
I will think about re-authoring it and publishing it, however, I can't post it as it is a confidential document that doesn't belong to me. (What a silly cop-out, no?)
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego. -
There is a special circle of hell for the bigots that write these documents. There, I said it, flame me if you wish. I will be busy writing good code that doesn't conform. BTW, to admit hypocrisy, I once wrote a style guide. It was only two pages long, incorporated everything, and would have fixed 90% (I am not exaggerating) of the problems on the project it was written for, and was flexible enough, to gasp, accommodate people. The reason it was rejected was not because of content, the content was approved and lauded. It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice. The real irony is that style guide is somehow read as style law?
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.I do agree. There should be just a (possibly short) style guide. :)
If the Lord God Almighty had consulted me before embarking upon the Creation, I would have recommended something simpler. -- Alfonso the Wise, 13th Century King of Castile.
This is going on my arrogant assumptions. You may have a superb reason why I'm completely wrong. -- Iain Clarke
[My articles] -
There is a special circle of hell for the bigots that write these documents. There, I said it, flame me if you wish. I will be busy writing good code that doesn't conform. BTW, to admit hypocrisy, I once wrote a style guide. It was only two pages long, incorporated everything, and would have fixed 90% (I am not exaggerating) of the problems on the project it was written for, and was flexible enough, to gasp, accommodate people. The reason it was rejected was not because of content, the content was approved and lauded. It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice. The real irony is that style guide is somehow read as style law?
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.Ennis Ray Lynch, Jr. wrote:
It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice.
That's quality control for you - it's quantity not quality.
Deja View - the feeling that you've seen this post before.
-
There is a special circle of hell for the bigots that write these documents. There, I said it, flame me if you wish. I will be busy writing good code that doesn't conform. BTW, to admit hypocrisy, I once wrote a style guide. It was only two pages long, incorporated everything, and would have fixed 90% (I am not exaggerating) of the problems on the project it was written for, and was flexible enough, to gasp, accommodate people. The reason it was rejected was not because of content, the content was approved and lauded. It was rejected because a style guide that small was not believable and they wanted a massive all controlling document that left nothing to choice. The real irony is that style guide is somehow read as style law?
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.Totally agree with you. I had a look at that link, and just couldn't be bothered with that guide after a couple of pages. You could guess its been commissioned by a big company, with a team of people sitting through meeting after meeting, for months on end until they could come up with something that everyone would agree to. And they end up with a document so long its virtually unfit for purpose.
Words fade as the meanings change, but somehow, it don't bother me.
-
I will think about re-authoring it and publishing it, however, I can't post it as it is a confidential document that doesn't belong to me. (What a silly cop-out, no?)
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.What if we create a fake company, that fake hires you, on a fake project to create a "style guide" for our new fake project. In the process, we, the fake company, agree that publishing your guide would be a wonderful idea, and allow you free reign to do so. I've got a fake contract ready to go...
¡El diablo está en mis pantalones! ¡Mire, mire! Real Mentats use only 100% pure, unfooled around with Sapho Juice(tm)! SELECT * FROM User WHERE Clue > 0 0 rows returned Save an Orange - Use the VCF! VCF Blog
-
What if we create a fake company, that fake hires you, on a fake project to create a "style guide" for our new fake project. In the process, we, the fake company, agree that publishing your guide would be a wonderful idea, and allow you free reign to do so. I've got a fake contract ready to go...
¡El diablo está en mis pantalones! ¡Mire, mire! Real Mentats use only 100% pure, unfooled around with Sapho Juice(tm)! SELECT * FROM User WHERE Clue > 0 0 rows returned Save an Orange - Use the VCF! VCF Blog
mmmm, Fake compensation, yummy.
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego. -
mmmm, Fake compensation, yummy.
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.Daft Faker, leader of the Microsoft Imperial Fleet?
------------------------------------ "October: This is one of the peculiarly dangerous months to speculate in stocks in." - Mark Twain
-
mmmm, Fake compensation, yummy.
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.Plus, with the new McCain-Obama Tax Plan, there is NO tax on fake compensation under 2 billion dollars.
¡El diablo está en mis pantalones! ¡Mire, mire! Real Mentats use only 100% pure, unfooled around with Sapho Juice(tm)! SELECT * FROM User WHERE Clue > 0 0 rows returned Save an Orange - Use the VCF! VCF Blog
-
I will think about re-authoring it and publishing it, however, I can't post it as it is a confidential document that doesn't belong to me. (What a silly cop-out, no?)
Need software developed? Offering C# development all over the United States, ERL GLOBAL, Inc is the only call you will have to make.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
Most of this sig is for Google, not ego.Modify it so it doesn't have any proprietary stuff and post it as an article. Dare!
-
Plus, with the new McCain-Obama Tax Plan, there is NO tax on fake compensation under 2 billion dollars.
¡El diablo está en mis pantalones! ¡Mire, mire! Real Mentats use only 100% pure, unfooled around with Sapho Juice(tm)! SELECT * FROM User WHERE Clue > 0 0 rows returned Save an Orange - Use the VCF! VCF Blog
The Cake is a Fake.
Todd Smith
-
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!