I'm wondering if there are any reasons (apart from tidying up source code) why developers use the "Remove Unused Usings" feature in Visual Studio 2008?
- I believe that's a feature of PowerCommands for Visual Studio, not of Visual Studio itself.Hosam Aly– Hosam Aly2009-03-10 11:11:41 +00:00Commented Mar 10, 2009 at 11:11
- 3In VS2008 it is certainly a feature (along with the ability to sort the using statements) of VS itself.Richard– Richard2009-03-10 11:32:42 +00:00Commented Mar 10, 2009 at 11:32
- 1@Hosam: PowerCommands enables you to do that for the entire project/solution. Doing that per file is a feature of VS itself.configurator– configurator2009-03-13 03:15:07 +00:00Commented Mar 13, 2009 at 3:15
- 3BTW, check out Resharper if you want more precise control over this kind of cleanup.John Feminella– John Feminella2009-03-14 11:15:43 +00:00Commented Mar 14, 2009 at 11:15
- 2I actually really dislike this feature -- I invariably find myself editing a file and having to re-add all the System namespaces after someone's cleaned them up (usually System, System.Collections.Generic, and System.Linq.) I find it adds more friction than it saves. Now, your own project namespaces rather than framework namespaces -- those make more sense to clean up, to clarify the wiring of your program. Wish there were a way to have VS clean up imports only from certain namespaces and leave the System ones that you more frequently need.user1454265– user14542652015-02-12 18:35:53 +00:00Commented Feb 12, 2015 at 18:35
10 Answers
There are a few reasons you'd want to take them out.
- It's pointless. They add no value.
- It's confusing. What is being used from that namespace?
- If you don't, then you'll gradually accumulate pointless
usingstatements as your code changes over time. - Static analysis is slower.
- Code compilation is slower.
On the other hand, there aren't many reasons to leave them in. I suppose you save yourself the effort of having to delete them. But if you're that lazy, you've got bigger problems!
11 Comments
I would say quite the contrary - it's extremely helpful to remove unneeded, unnecessary using statements.
Imagine you have to go back to your code in 3, 6, 9 months - or someone else has to take over your code and maintain it.
If you have a huge long laundry list of using statement that aren't really needed, looking at the code could be quite confusing. Why is that using in there, if nothing is used from that namespace??
I guess in terms of long-term maintainability in a professional environment, I'd strongly suggest to keep your code as clean as possible - and that includes dumping unnecessary stuff from it. Less clutter equals less confusion and thus higher maintainability.
Marc
Comments
In addition to the reasons already given, it prevents unnecessary naming conflicts. Consider this file:
using System.IO; using System.Windows.Shapes; namespace LicenseTester { public static class Example { private static string temporaryPath = Path.GetTempFileName(); } } This code doesn't compile because both the namespaces System.IO and System.Windows.Shapes each contain a class called Path. We could fix it by using the full class path,
private static string temporaryPath = System.IO.Path.GetTempFileName(); or we could simply remove the line using System.Windows.Shapes;.
Comments
This seems to me to be a very sensible question, which is being treated in quite a flippant way by the people responding.
I'd say that any change to source code needs to be justified. These changes can have hidden costs, and the person posing the question wanted to be made aware of this. They didn't ask to be called "lazy", as one person inimated.
I have just started using ReSharper, and it is starting to give warnings and style hints on the project I am responsible for. Amongst them is the removal of redundant using directive, but also redundant qualifiers, capitalisation and many more. My gut instinct is to tidy the code and resolve all hints, but my business head warns me against unjustified changes.
We use an automated build process, and therefore any change to our SVN repository would generate changes that we couldn't link to projects/bugs/issues, and would trigger automated builds and releases which delivered no functional change to previous versions.
If we look at the removal of redundant qualifiers, this could possibly cause confusion to developers as classes in our Domain and Data layers are only differentiated by the qualifiers.
If I look at the proper use of capitalisation of anachronyms (i.e. ABCD -> Abcd), then I have to take into account that ReSharper doesn't refactor any of the Xml files we use that reference class names.
So, following these hints is not as straight-forward as it appears, and should be treated with respect.
1 Comment
Less options in the IntelliSense popup (particularly if the namespaces contain lots of Extension methods).
Theoretically IntelliSense should be faster too.
1 Comment
Code compiles quicker.
5 Comments
Recently I got another reason why deleting unused imports is quite helpful and important.
Imagine you have two assemblies, where one references the other (for now let´s call the first one A and the referenced B). Now when you have code in A that depends on B everything is fine. However at some stage in your development-process you notice that you actually don´t need that code any more but you leave the using-statement where it was. Now you not only have a meaningless using-directive but also an assembly-reference to B which is not used anywhere but in the obsolete directive. This firstly increases the amount of time needed for compiling A, as B has to be loaded also.
So this is not only an issue on cleaner and easier to read code but also on maintaining assembly-references in production-code where not all of those referenced assemblies even exist.
Finally in our exapmle we had to ship B and A together, although B is not used anywhere in A but in the using-section. This will massively affect the runtime-performance of A when loading the assembly.
Comments
At least in theory, if you were given a C# .cs file (or any single program source code file), you should be able to look at the code and create an environment that simulates everything it needs. With some compiling/parsing technique, you may even create a tool to do it automatically. If this is done by you at least in mind, you can ensure you understand everything that code file says.
Now consider, if you were given a .cs file with 1000 using directives which only 10 was actually used. Whenever you look at a symbol that is newly introduced in the code that references the outside world, you will have to go through those 1000 lines to figure out what it is. This obviously slows down the above procedure. So if you can reduce them to 10, it will help!
In my opinion, the C# using directive is very very weak, since you cannot specify single generic symbol without genericity being lost, and you cannot use using alias directive to use extension methods. This is not the case in other languages like Java, Python and Haskell, in those languages you are able to specify (almost) exactly what you want from the outside world. But even then, I will suggest to use using alias whenever possible.