Hi Mike,
I have found the following behaviour on comment roundtrip engineering.
Class notes (forward):
- comment starts with '/*'
- no changes are made in comments (including tabs and enters)
- comment ends with '*/'
Class notes (reverse):
- Some asterixes are removed (sorry not yet further explored)
- CR/LF are removed, with the following exceptions:
- when there is not a '.' at the end of a line
- when there is a '-' at the start of the next line
Method notes (forward):
- comments start with '/**'
- each line starts with '* '
- rest of comments is not changed
- comments end with '*/'
Method notes (reverse):
- Seems to reverse the forward engineering
Method behaviours (forward):
- each commentline starts with '//'
Others:
- Haven't tested other comment roundtrip engineering yet.
-------------------
I personally think that forward engineering is pretty OK, but reverse engineering comments (and code) is not solid and therefore not useable yet.
Furthermore, I think that some of the note fields (e.g. with methods) are rather small to include the extensive documentation I would like.
-------------------------
Suggestions to Sparx:
- Provide the rules of comment engineering for all kind of note fields.
- Provide a larger box for method notes.
- Provide settings (in profile) for changing comment styles.
- Besides behaviour, I would like to have a field (same size) for the code I want to include.
In general:
I think that Sparx needs to concentrate on forward and reverse engineering code. This board already mentions some cavities in both forward and reverse engineering that makes the tool, in my opinion, rather useless in roundtrip engineering.
So, instead of adding nice features (and know that I would like them all, now,
of course), I think Sparx needs to concentrate on the already included functionality.
For the short term, I would like to be notified on the focus of the Sparx team efforts, and possibly on the above issues.
Greetings,
Tjerk
