In a previous post this summer I mentioned what has been one of the best advice I got this year (from Bob Powell and Fabrice Marguerie):
When you
target .NET developers, the closer to VisualStudio’UI, the better your UI is.
Here is another great advice I got this year from Scott Hanselman when he was playing with VisualNDepend:
I want to live in there (i.e in VisualNDepend), I don't want any additional UI.
Following these advices, we are now happy to release NDepend v2.6. It comes with a project management and an analysis life cycle similar to the Visual Studio one. Concretely, we added 3 panels to VisualNDepend:
- Start Page
- Error List
- Project Properties
On a side note this new version also comes with a Visual Studio studio addin compatible with VS2008 and support .NET3 \ .NET 3.5 assemblies analysis.
Start Page
The Start Page represents a powerful and widely accepted way to show at a glance common beginning tasks, including,
- Create\Open project,
- Analyze a set of .NET assemblies,
- Compare 2 sets of assemblies.
For beginners' users, the Start Page comes with some links to the
Getting Started documentation. It is also a convenient place from where to install\uninstall
Visual Studio and
Reflector addins. Finally, the Start Page can inform user if she's running or not the latest version available.
My friend Sebastien Andreo often says:
Make the simple things simple and the hard things possible.
Following this tenet, there is a right-click menu on Recent Projects to choose between loading the results of the most recent analysis, the result of an analysis previously done, or just the project properties. By default, left-clicking a recent project opens its most recent analysis or the project itself if the most recent analysis is not available.
Of course, the Start Page panel remains active and available at any time, whether the user is sifting the result of an analysis, run an analysis, edit some project properties...
Error List
Beside all the Code Query Language possibilities to analyze a code base, NDepend is able to provide numerous useful information about the health of your build process, including:
- Assemblies versionning issues such as:
- AssemblyA references AssemblyB v2.1 but only AssemblyB v2.0 is available.
- AssemblyA references 2 versions of AssemblyB (which is not necessarily a bad thing, but it's still useful to be aware of such situation).
- Assembly conflicts such as:
- The name of me assembly main module file is different from the logical name of my assembly.
- Several different assemblies with the same name can be found (different = different hash code and/or different version).
- PDB files issues such as:
- Missing PDB files.
- PDB files and code source files not in-sync.
- PDB files and assemblies are not in-sync.
So far, this precious information emitted during analysis, was kind of buried in a section of the report. It is now available in a Error List panel. The different warnings are visible at any time, both during analysis and also when exploring results of an analysis. There is also the convenient facility to enable\disable warnings.
Project Properties
Finally, we discarded the NDepend.Project.exe UI. The new Project properties panel makes easier the choice of .NET assemblies to analyze. Also, the list of Tiers Assemblies (i.e the assemblies that we don't develop but that are used by the assemblies of our application) is now automatically inferred from the list of the application assemblies.
Personally, I like to use this Code to Analyze panel to have a thorough view of the set of my assemblies, with information such as:
- Which assemblies is strong named or not (sn column)?
- Which assemblies come with a pdb file (pdb column)?
- Size, Platform and target Runtime of my assemblies.
- How many assemblies are referenced by a given assembly (+ the list of referenced assemblies in a tool tip).
- What is the list of Tiers assemblies used by my application?
Of course, you already know about this information thanks to Windows Explorer, Reflector, Ildasm, Visual Studio... The cool thing here is that the Code to Analyze panel centralizes all this.
Still following the Make the simple things simple and the hard things possible tenet, the editor of folders that contain your assemblies is now hidden by default. It becomes visible thanks to a extender button. The list of folders is populated automatically when you select your application assemblies. This folders tab is useful if you want to tweak the existing set of folders or if you want to switch to Relative path mode. In Relative path mode, folders are relative to the NDepend project file location. It is useful to use the same project on different machines. Also, for a given folder, the Folders tab shows at a glance which assembly is an Application one (green) a Tier one (blue) not used (white) and also which .exe and .dll files are not assemblies.
In the tab of Project Properties panel and a bit everywhere in the VisualNDepend UI, we are now using an Office 2007 invention that I don't know the name of. I would call this Info tooltip. It consists in providing a tiny information icon that displays a tooltip. I found it more convenient than classic tool tip on control because:
- With classic tooltip, when discovering a form the user doesn't know which control has a tooltip or not.
- The tooltip information is displayed immediately when the mouse hovers the Info tooltip, there is no classic half-second wait.
We use
Info tooltip as a consolidation for the classical documentation. We all know that users barely read manual and my opinion is that
Info tooltip is a good way to access documentation just-on-time. For example, here, we estimate that if the user is using its own Xsl sheet to build report, she might want to know where she can find information about how she can build a custom Xsl sheet.
