Software Quality Blog - SubMain Software - Code Quality Tools, Automated Code Review and Refactoring

CodeIt.Right Rules Explained, Part 17

June 19, 2018Erik DietrichArticles, CodeIt.Right, ErikDietrich, Rules, RulesExplainedNo Comments

It’s time for a deep dive into yet another three CodeIt.Right rules. In case you’ve missed it, this continues a post series in which we, well, do a deep dive into the CodeIt.Right Rules.

CodeIt.Right is an automated code review tool, making it fall under the broad heading of static analyzers. It checks your source code against a set of rules, both ones that you customize and a set that comes out of the box. In this series, we’re focusing on the latter, since those are the ones that will obviously apply to everyone.

Followers of this series will know that I always kick the posts off by listing two static analysis rules of thumb that I advertise as good ideas.

Never implement a suggested fix without knowing what makes it a fix.
Never ignore a suggested fix without understanding what makes it a fix.

If this seems a little obtuse, it’s probably because you could condense these two rules into a single one by logical implication: “always understand a suggested fix.”

But I deliberately choose not to phrase it this way, opting for the two separate rules. I do this to emphasize your choice: ignore the warning or implement a fix. If you decide to ignore the warning, you should do so only when you’re fully aware of the risks of doing so. If, on the other hand, you decide to fix the warning, you should always understand what you’re doing when you change your own code. Otherwise, you’re programming by coincidence.

Don’t program by coincidence. Instead, take a look at today’s three rules.

(more…)

C# Enum: Definition, Examples, Best Practices, and Pitfalls

June 12, 2018Justin BoyerArticles, CodeBasics, CodeQuality, JustinBoyer2

We’ve discussed arrays and lists in C#. This time, we’ll take the same journey with a funky little type called the enum. C# enums are very useful constructs, but they have some quirky behavior that can bite you if you’re not careful.

Let’s now see what makes enums tick, how to use them effectively, and what to be careful of when using them. (more…)

Writing that says "rules, you must, you must not"

Using CodeIt.Right to Create C# Coding Standards

June 5, 2018Carlos SchultsArticles, CarlosSchults, CodeIt.Right, CodeReviews, TeamStandardNo Comments

Does your team use a coding standard? If the answer is no, then I’m afraid you’re missing out on a lot of important benefits. This post will help you create (and automate) C# coding standards using Submain’s CodeIt.Right. I’ll start out by making the case that you need a coding standard. We here at the SubMain blog have already covered that subject, of course, but I’ll revisit it anyway.

With that out of the way, I’ll go on to explain the most common problems that occur when teams try to implement coding standards and code reviews manually.

Finally, I’ll show you how automation can heal these pains, and how to use CodeIt.Right for doing so. Let’s get started. (more…)

Is XML Dying?

May 29, 2018T.J. SimmonsArticles, GhostDoc, TJSimmons4

Since the beginning, web developers have always needed to transport and store data, and there’s an entire generation of web developers that has only ever used JSON (JavaScript Object Notation) for that purpose. That choice makes sense; JSON is easy to read and conforms to JavaScript syntax. Some developers may not have even heard of XML (eXtensible Markup Language). XML was also designed to be both human- and machine-readable. Its purpose is primarily to handle the transportation and storage of data. And this data exchange was not meant for web only. Most importantly, distributing data of different flavors works fantastically well with XML, all because XML is designed to be highly flexible within a strict structure. Yet JSON continues to be the first choice for many developers. Which prompts the question: is XML dying?

In this article, we will explore the differences between XML and JSON. We will address which conditions best suit which format. At the end, we’ll dig into a few scenarios where XML will continue to play a crucial role in data exchange.

(more…)

Understanding the .NET Build Configuration System

May 22, 2018Peter MorlionArticles, CodeIt.Right, PeterMorlion2

When you create a .NET application in Visual Studio, it contains two build configurations: Debug and Release. But what does this mean exactly? Most developers will tell you that you can transform your Web.config or App.config based on the selected build configuration. For example, when you select “Debug,” your database connection string might point to a database on your PC (i.e. “localhost”). Then, when you select “Release,” it could point to the production database.

But the build configuration system in .NET goes beyond just transforming the config file. There is a whole system of solution and project configuration management that you can use to your advantage.

A project configuration contains a set of properties to be used when building the project. Likewise, a solution configuration contains a set of properties at the solution level. But it also contains the selected project configurations for that solution configuration. An example should clarify.

(more…)

C# List: Definition, Examples, Best Practices, and Pitfalls

May 15, 2018Carlos SchultsArticles, CarlosSchults, CodeBasics, CodeQuality1

Not that long ago, we published a post about the fundamentals of the C# array. Today’s post will continue the trend, covering the C# list. Don’t worry: if you’re a beginner, you’ll also benefit from this post. Instead of brushing up, you’ll get your first contact with this incredibly useful data structure.

As in the array post, we’ll discuss what a list is. We’ll learn how to use it, what its most common operations are, and how to avoid some common pitfalls. With that in mind, you’re ready to see what the C# list has to offer you.

(more…)

CodeIt.Right Rules Explained, Part 16

May 8, 2018Erik DietrichArticles, CodeIt.Right, ErikDietrich, RulesExplainedNo Comments

Today, we bring you another post in the CodeIt.Right Rules Explained series. Up until this point, I’ve been chronicling these posts by their number in the series, but I realize that the numbering: is both academic and relatively easily inferred via the posting category. Nevertheless, in spite of changing the approach to the title, I’ll recap the premise, as I always do.

CodeIt.Right is an automated .NET code review tool. That means that it automatically analyzes your code and applies rules to it. In the posts in this series, I explain those rules in detail.

In all posts in this series, I start out by listing these rules of thumb for static analysis in the hopes that repetition makes the point.

Never implement a suggested fix without knowing what makes it a fix.
Never ignore a suggested fix without understanding what makes it a fix.

I’ll also explain, as I always do, that I don’t use this phrasing to seem clever or because I can’t figure out the more succinct logical conclusion that these two statements imply: that you should always understand why the tool is suggesting a fix.

I do this because static analyzer warnings present you with a choice: address the warning or ignore it. And, whichever path you choose, you should do so deliberately and for the right reasons. Decide to ignore the warning because you think what you’re doing isn’t actually a problem. Or decide to address the warning because you understand that what you’re doing is problematic and not because you’re programming by coincidence. Always know what you’re doing.

And with that, let’s dive into today’s rules.

(more…)

9 Tips for Simplifying Your Code Documentation

May 1, 2018Peter MorlionArticles, Documentation, GhostDoc, PeterMorlion2

Documenting your code is important. It tells other developers what the code does, why it is constructed in a certain way, and how to use it. Good documentation saves them time when they are trying to perform a certain task that isn’t straightforward. It will probably also save you time because the human brain can only store so much information. Even your own code will confuse you at some point in the future.sp

Even though code documentation is important, many developers find it tedious. This is exacerbated by the fact that many companies associate code documentation with long Word documents that must be kept up to date manually. Not exactly developer heaven.

So how can we simplify code documentation while still keeping it effective? (more…)

5 Ideas for Rules to Add to Your CodeIt.Right Profile

April 24, 2018Erik DietrichArticles, CodeIt.Right, ErikDietrich, RulesNo Comments

A while back, I wrote on the subject of code review horror stories. This was mostly for fun, but it does speak to an important truth. Code reviews can be pretty contentious, unpleasant, and even counterproductive when done wrong.

I could spend a bunch of time today talking about how to do them right. But I won’t. Instead, I’ll talk about ideas for how to automate your way around possible points of contention. I’m nothing if not a software developer at heart.

Automated Code Review Goes Beyond the Default Rules

You might be wondering how one “automates around” contentious code reviews. Perhaps you think I’m proposing some kind of pie-in-the-sky scheme to say, “Alexa, review my code.” But no. I’m talking about extending CodeIt.Right’s automated review capabilities.

I have a long-running series on this blog, explaining CodeIt.Right’s automated code review rules. In those posts, I talk about how you should be very deliberate about either heeding the tool’s advice, or deciding to ignore/deactivate a given rule.

But I never really talk about the idea of adding your own rules.

And that’s what we’re going to do today. You don’t have to use a tool like CodeIt.Right only for its out of the box capabilities when it offers you a rich customization platform backed by a fully featured API. You can write your own rules.

And you should write your own rules. Developers waste an awful lot of time in code reviews endlessly rehashing checks that could be automated easily. And just because it’s something perhaps more specific to your team that hasn’t yet been automated doesn’t mean that you can’t automate it—and pretty easily, at that.

So let’s take a look at five ideas for rules you should add to your CodeIt.Right profile.

(more…)

C# Array: Definition, Examples, Best Practices, and Pitfalls

April 17, 2018Justin BoyerArticles, CodeBasics, CodeQuality, JustinBoyer2

So you’ve started your journey into C# development. Learning any new language or framework can be a challenging road. However, you need not despair. Allow those who have gone before you to lead the way and guide you on your journey. Today’s leg of the journey is the C# array.

In this post, we’ll discuss what an array is. We’ll see how to use one in our code, and we’ll discuss how best to use it and what pitfalls can hurt your code quality.

(more…)