tmapinet-discuss

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

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

Hi Stefan and Ralf,

as I told you at TMRA, I would recommend to modify the sources to be
consistent with the naming conventions of the MSDN [1]. This is useful to
for developers using your sources for other projects. If you want I can fix
those naming issues.

Best regards

Marcel

[1] http://msdn.microsoft.com/en-us/library/xzf533w0(VS.71).aspx


--
____________________________________________

 Marcel Hoyer
 Dipl.-Ing. (BA) für Informationstechnik
 Expert Student Partner (Microsoft Student Program)
 Microsoft Certified Technology Specialist
   * .NET Framework 3.5 - Windows Presentation Foundation Applications

 http://marcelhoyer.de/
____________________________________________

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

[Stefan K. <ste...@we...>]

Hi Marcel,

at first: Welcome on board :)

We're aware of the namespace issue: 'org.tmpai' should be renamed to
'Org.Tmapi', right?

Are there any other naming issues you stumbled upon?


With kind regards,

Stefan

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/ 

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

[Stefan K. <ste...@we...>]

Hi Marcel,

> [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?
>   
We have a strong Java background and so a lot to learn regarding .Net
specific things.
Getting closer to the .Net world shouldn't be a problem indeed if it
would ease implementation we should take this way.

> [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?
>   
Generating the documentation wasn't so straight forward as using JavaDoc ;)
During the build process some XML files with the comments are generated.
After this we used SandCastle to generate the .chm file.
> Just for information: What is your development environment? Do you use some
> kind of refactoring tool?
>   
Visual Studio 2008 Professional with Resharper 4.1.


With kind regards,

Stefan

[Tmapinet-discuss] TMAPI.Net alpha vs. original TMAPI source

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

Hi Stefan and Ralf,

do you know what SVN revision of TMAPI was the source of your TMAPI.Net
port? Just to get an overview on the changes we have to port in addition
from TMAPI to TMAPI.Net. I think it would be much easier to go step by step
through the change logs of TMAPI to integrate those into TMAPI.Net.

With kind regards,

Marcel

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

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

Hi Stefan,

as you may mentioned I fixed most of the warnings spit out by CodeAnalysis
and StyleCop. At the moment I just receive 85 Warnings. So check out the new
revision.

To prevent misspelling and layout issues I can recommend the AgentSmith
plugin for ReSharper [1]. But you have to configure the rules. You should
have a look at your ReSharper formatting options too to match the current
code style.

As you use Visual Studio too, shouldn't we check in the Visual Studio
solution and project files?

Tomorrow I'm going to refactor the namespace to TMAPI.Net.Index
(TMAPI.Net.Core).

Best regards

Marcel

[1] http://www.agentsmithplugin.com/