New Posts New Posts RSS Feed: Class Documentation
  FAQ FAQ  Forum Search   Calendar   Register Register  Login Login

Class Documentation
 Post Reply Post Reply
Author
  Share Topic Share Topic  Topic Search Topic Search  Topic Options Topic Options
eileenv View Drop Down
IdeaBlade
IdeaBlade
Avatar

Joined: 15-Jun-2007
Location: United States
Posts: 68 		Post Options Post Options   Quote eileenv Quote  Post ReplyReply Direct Link To This Post Topic: Class Documentation
    Posted: 26-Nov-2007 at 6:04pm

Capturing the Description field from the database table is currently on our Features list. As we are working on our next generation Object Mapper, this feature will most likely be made available in version 4.x.



Edited by eileenv - 26-Nov-2007 at 6:11pm
Back to Top
rclarke View Drop Down
Groupie
Groupie


Joined: 14-Jun-2007
Location: United States
Posts: 69 		Post Options Post Options   Quote rclarke Quote  Post ReplyReply Direct Link To This Post Posted: 25-Nov-2007 at 8:34am
I like the idea of being able to add a commnt for a property in the mapper but I think that the initial comment should be derrived from the database description field for the column. This way database documentation tools that produce documentation would still work and the same comments could be captured by the mapper and the programmer could augment or replace the comments in the mapper.
 
BTW, would you consider making your 'ORM Documentor' available?
Back to Top
jforgan View Drop Down
Newbie
Newbie


Joined: 05-Jul-2007
Location: Australia
Posts: 1 		Post Options Post Options   Quote jforgan Quote  Post ReplyReply Direct Link To This Post Posted: 22-Nov-2007 at 2:39pm
 
We've developed an 'orm documentor' app which reads the DevForce .orm file and generates all the overrides and puts them in a .cs file. It generates complete 'skeleton' classes which include the property and relation property definitions along with comment sections.
 
We then include the .cs file in our solution and edit it to add the comments to each property.
 
If we re-run our documentor we can point it to our existing .cs file so that it picks up any existing comments and includes them against the relevant property when the file is regenerated.
 
At the very least it would be great if the ORM allowed you to define a comment against a property. Would seem to be a fairly simple enhancment because it's just some text that gets saved away in the .orm xml file - no validation required!
 
 
Back to Top
m2r4miller View Drop Down
Newbie
Newbie
Avatar

Joined: 19-Aug-2007
Location: United States
Posts: 12 		Post Options Post Options   Quote m2r4miller Quote  Post ReplyReply Direct Link To This Post Posted: 05-Oct-2007 at 8:32am
Yes, that would be wonderful if they would capture the Description property of the table in comments as I use that property alot in my database designs.
 
We can hope, eh?
-Mark
Email
Blog
Back to Top
rclarke View Drop Down
Groupie
Groupie


Joined: 14-Jun-2007
Location: United States
Posts: 69 		Post Options Post Options   Quote rclarke Quote  Post ReplyReply Direct Link To This Post Posted: 04-Oct-2007 at 2:16pm
Mark,
I guess my original message was not clear. I know how to use Sandcastle. I would like to have a way to use Sandcastle to document properties within entities. The only way I know how to do this is to override every property in the final class just for purposes of adding the XML comments. What would be really cool is if Ideablade could capture the database column description and generate an XML comment in the <Entity>DataRow class for each property.
Back to Top
m2r4miller View Drop Down
Newbie
Newbie
Avatar

Joined: 19-Aug-2007
Location: United States
Posts: 12 		Post Options Post Options   Quote m2r4miller Quote  Post ReplyReply Direct Link To This Post Posted: 10-Sep-2007 at 9:43am
Download and install the following:
3. Sandcastle Help File Builder GUI tool: http://www.codeplex.com/SHFB
 
In Visual Studio 2005, right click your Model project, select Properties, then the Build tab, and check the XML Documentation File box in the Output section.
 
Next Build your Model project, and run the Sandcastle GUI. Select the Model.XML in the \bin\debug|release folder and build the file.
 
It takes a while, but works very well.
 
-Mark
Back to Top
rclarke View Drop Down
Groupie
Groupie


Joined: 14-Jun-2007
Location: United States
Posts: 69 		Post Options Post Options   Quote rclarke Quote  Post ReplyReply Direct Link To This Post Posted: 09-Aug-2007 at 8:16am
I would like to use Sandcastle to provide documentation for my model classes. The only way I see to do this is to override each property in the final class which is a lot of additional work and I'm not so sure it's a good idea anyway. Unless I'm missing something, there is no other quick way to do it. If anyone has any ideas please post them.
 
 
Back to Top
 Post Reply Post Reply

Forum Jump Forum Permissions View Drop Down