Re: [Tmapinet-discuss] TMAPI.Net alpha - Naming conventions

[Marcel H. <mh...@pi...>]

Hi Stefan,

> 
> Hi Marcel,
> 
> at first: Welcome on board :)
> 
[mh] 
Thanks a lot.

> We're aware of the namespace issue: 'org.tmpai' should be renamed to
> 'Org.Tmapi', right?
> 
[mh] 
Writing Org.Tmapi in pascal case is a first step. :-) But in the .NET world
we usually don't use the reverse domain style for namespaces. My
recommendation would be to put the interfaces and classes in the following
structure:

  * TMAPI.Net.Core
    - FactoryConfigurationException
    - FeatureNotRecognizedException
    - FeatureNotSupportedException
    - ...
  * TMAPI.Net.Index
    - IIndex
    - ILiteralIndex
    - IScopedIndex
    - ITypeInstanceIndex
  * TMAPI.Net.Core.Tests
    - ...
  * TMAPI.Net.Index.Tests
    - ...

Of course with this step we are going to distance our self a little bit from
the TMAPI 2.0 Java implementations. But in my opinion we have to look at the
platform specifics and consistencies as well as the TMAPI 2.0 specs. What do
you think about this?

> Are there any other naming issues you stumbled upon?
[mh] 
I just did a quick review on your sources. I'm going to check those using
StyleCop [1] and FxCop [2]. I'm curious about the results. 599 warnings. ;-)
But calm down, not all of them are that important.

I found some referencing issues in the documentation like this:

    /// <summary>
    ///     Exception thrown when the <see
cref="T:org.tmapi.core.TopicMapsSystemFactory"/> does not 
    ///     recognize the name of a feature that the application is trying
to enable or disable.
    /// </summary>
    [Serializable]
    public class FeatureNotRecognizedException

The <see>-reference [cref="T:org.tmapi.core.TopicMapsSystemFactory"] does
not point to the correct factory class name (TopicMapSystemFactory without
"s" after TopicMap). Maybe this is the source for the broken CHM help file?
How did you create the CHM? Isn't the generator tool printing out those
wrong reference issues?

Just for information: What is your development environment? Do you use some
kind of refactoring tool?

> 
> 
> With kind regards,
> 
> Stefan

Best regards

Marcel

[1] http://code.msdn.microsoft.com/sourceanalysis 
[2] http://blogs.msdn.com/fxcop/