Archive for August, 2017

Naming Test Methods

When I first started writing unit tests, I followed the common convention in C# for method naming:

WithdrawingMoneyShouldDecreaseBalanceByAmount

Later, I adopted the convention of separating words with underscores:

Withdrawing_Money_Should_Decrease_Balance_By_Amount

At some point I figured the approach above makes the name of the method look like the title of an article. I then decided to go with the same approach, but making everything lower case:

withdrawing_money_should_decrease_balance_by_amount

In some cases, I may use uppercase if I want to draw attention to something in particular:

withdrawing_money_should_DECREASE_balance_by_amount

I like when the code is calm to look at, and it draws my attention to things as appropriate.

Advertisements

Leave a comment

Moving Windows Around Using Only Keyboard on Mac and PC

If there’s anything I do all the time, I try to either find or create a shortcut so I can do it using only the keyboard. Moving windows around is one of those things (maximize, minimize, dock to different parts of the screen, move to different monitors, etc.).

On the PC, I use the combination WinKey+(up/down/left/right arrows). For instance, say I’m working with Notepad like this:

If I want it maximized, I hit the Windows Key + Up Arrow:

If I want it restored back to its original state, just hit Windows Key + Down Arrow.

If I need it docked to either the right or left side of the screen, I hit Windows Key + Left/Right Arrow:

If I want to move the window moved to another monitor, just keep hitting Windows Key Left/Right Arrow until the window makes it to the other monitor (once it gets there, I usually hit Windows Key + Up Arrow so it gets maximized).

On the Mac, I use the SizeUp app, which gives me even more options to manage windows on my screen:

I use these shortcuts all day long!!

2 Comments

Visual Studio’s own feature for windows layouts

As it turns out, I just realized the post where I talk about switching windows layouts in Visual Studio 2017 was dead on arrival. Well, the tips I gave regarding exporting/importing settings and using VCmd to automate some of that is still relevant and useful.

However, for switching windows layouts, somewhere between VS 2013 and 2017 the tool finally introduced something to make that easier:

Regardless of the approach, please consider using your screen real state wisely. I see a lot of developers fighting VS with its several windows all crammed into one screen, while the other screen has either MS-Outlook or a web browser open at all times showing all sorts of useless things that can only steal away productivity and focus.

Leave a comment

Great screen capture tool I use on temporary computer environment

A long time ago I wrote about screen capture. That was 10 years ago. I was using SnagIt. I still am. I like the fact it has a PC and a Mac version, and I use them both every single day.

There are times, however, when I’m doing temporary work at a client’s machine and I don’t want to use my personal SnagIt license, so I use the next best thing: Jing (also by TechSmith). It’s free, and it has several of the main features I use all the time in SnagIt.

Jing has a quick access feature that sits at the top of my screen:

I select the window or area I want to capture, perform some basic annotation, and then either put it on the clipboard (usually to paste it on Evernote) or upload it to screencast.com (free service from TechSmith) so I can easily share the image through a link with other people:

That’s it: simple free tool that I use a lot everyday and makes me more productive. Win-win.

Leave a comment

When did you start writing clean code?

I was asked this question this week: “When did you start writing clean code?”. I hadn’t thought of that before. Pondering on the question, I remembered when I started paying more attention to writing better code. It also made me think when I do not write clean code. Here’s what I came up with…

When did I start writing clean code?

Going back in time some 25 years, I was working with good old Clipper. Some of the files I was working with had thousands and thousands of lines of code. I had to print out pages of code on a dot-matrix printer and then draw lines to connect if-blocks and things like that in order to make some sense out of it.

Eventually, I figured out I could move some blocks of code out to separate functions, so instead of reading 5k lines of code, I’d need to read only 2k. As time went by, that codebase was way easier to understand.

When I do not write clean code

For me, it isn’t possible to write clean code all the time. For example:

  • When I’m implementing some new feature and writing tests first
    • In a case like this, once I have a failing test, I’ll write whatever code it takes to make the test pass. That could mean having one class with a lot of ugly code. I don’t care. Once my test is passing, then I’ll look back at the nasty code and will do my best to make it better, given what I currently have available (my skill with the programming language, my knowledge of the framework or libraries used, my understanding of the requirements, the time I have available, etc.);
  • When I’m new to the programming language, framework, libraries, business domain, project…
    • In cases like this, there’s really so much I can do. In the beginning, things will come out a little (or a lot) ugly. As I learn, things will get better.

I remember moving from FoxPro to C#. As much as I though I was a good FoxPro developer and wrote good code, I just know my C# code was terrible. It took a while to learn how to write better C#.

When I moved from C# to Ruby, things were slightly different: I already knew my Ruby code would look bad initially, so I first learned how to write tests! I didn’t even worry about writing clean tests; I only cared about writing some test so I could “write Ruby code with a C# accent”, and once the tests were passing, I’d get help from somebody who knew a lot of Ruby to show me “The Ruby Way” (or more specifically, the Rails Way) for doing certain things.

Summing up

For me, at the end of the day I just want to make sure I wrote the best code I could, once again, given what I currently have available:

  • My skillset in the programming language, framework, libraries, etc.;
  • My understanding of the business domain;
  • My time available

,

Leave a comment

XmlDoc Comments: Auto Generate and Hide the Clutter

I mentioned how eager status code analysis is awful. A policy that forces developers to put XmlDoc comments is a good example of that.

This is how I see it: as I think through how I want to implement something I create an interface (created off tests I just wrote). The code might look something like this…

 

Right off the bat, VS is already showing me squigglies on the code I just wrote. I hover over it and this is what I see:


Right now I can’t even compile the code, and I don’t feel like typing Xml comments because I’m still thinking through my design and implementation. Parts of this interface are likely to be changed very quick, and any sort of documentation will become useless.

Since I need to conform with this policy, I use GhostDoc to just spit out the comments:


At this point I don’t really care whether the auto-generate comments make sense or not; I’m just satisfying what’s required in this development environment setup so I can get my immediate work done.

Of course, now what used to take just under 10 lines of code cannot even fit on my screen anymore and it requires scrolling!! That’s unacceptable to me. I can’t quite function seeing so much clutter! Fortunately, I’ve found this NoComment extension, which gets those comments out of my sight:


Now I can actually focus on what’s really important. Later, when I’m done with my design and implementation, then, and only then, I can review those Xml Comments prior to committing the work to the central source control repository.

Leave a comment

Eager static code analysis is awful

I like static code analysis.

I like how it reminds me how I can improve the code by applying certain refactoring patterns.

I like how it tells me how I can clean the code by using a new language feature I might not be aware of.

I like how it enforces a certain style and conventions on a codebase changed by several developers.

However, I have grown a special distate for static code analysis that’s run way too eagerly!

What do I mean by that? I do not like it when it’s run as I type the code. Done that way, it prevents me from finishing my thoughts. Many times I’m trying out ways to implement something, and I don’t like static analysis bugging me about things that aren’t important at that point in time. Treating those as errors make things even worse as the IDE shows red squigglies and distracts me.

I don’t like static analysis even when I compile the code. Why not? Because it gets in my way as I go through the Red-Green-Refactor process.

Static code analysis should run when we push the code to the central repository. At that point, check-in policies could block the commit if there are violations to the rules. Such analysis run any time before that is a productivity killer.

Leave a comment