Comments

[gyoung]

I just downloaded and installed this software a few days ago and I have a few issues on the comments in going to/from c#

How do I specify that something should be <Remarks> and not <Summary> ... In coming from C# it comes up as

comments

@Remarks comments


Is this the best method to handle this? Can I also do parameter level comments?

Liking the product so far.

Cheers,

Greg

[gyoung]

Actually while I am asking, what is the best way to handle attributes? and how does (if) the generics support work?

[Eve]

No support has been added for remarks, while all fields that don't directly fit are reversed  in closer to the javadoc style.

Parameter level comments should automatically be attached to the parameter notes.

Attributes are handled by attaching a tagged value 'Attribute' = '[MyFirstAttribute];[MySecondAttribute]'  The whole attribute is specified, and multiple attributes are semi-colon seperated.

To answer your generics question I'll quote an answer from a support email I wrote to a user.

A simple generic class can be modelled by specifying the names of all generic parameters on the Detail tab of the class properties dialog.

As soon as constraints are placed on the parameters you need to add a tagged value "genericConstraints", where the value is the entire constraint clause.  Eg. "where T: new()".

If the class has a single parent that requires arguments, or all parents require the same arguments, you can set the arguments field to everything between "<" and ">".

If two or more parents require different generic arguments or you need an instantiated template class as a type you won't be able to use that field.  Instead you will need to replace all parents with their name, including the generic arguments.  (Ctrl + I)  Eg. You will have two parents "Dictionary<TKey,TVal>" and "IEvaluable<TVal>".  There will no longer be any generalisation link to these classes in the model.  Another example would be creating an attribute with the type "Dictionary<TKey,TVal>".

Finally, if you have a generic function, there is no generic parameters to define as there is for class.  As a result you need to create a tagged value "generic" with a value such as "<T>".  When constraints are required on generic functions you can use the same "genericConstraints" tag as found on classes.