473,395 Members | 1,484 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,395 software developers and data experts.

How to document strongly typed datasets (in source)

Hi,

for a project that I am wrapping up I am writing documentation. I'd like to
be able to put in xmldoc style comments in to the source of my strongly
typed dataset, its tables, relationshipts and fields.

Since the source files are auto-generated, which would imply that my
documentation would be deleted, where and how would I write in source
documentation?

Thanks
Nov 22 '05 #1
3 1278
Hi Tolga,

First of all, I would like to confirm my understanding of your issue. From
your description, I understand that you need to preserve xml comments in
the typed DataSet class. If there is any misunderstanding, please feel free
to let me know.

As far as I know, it is not recommended to add xml comments in the typed
DataSet class. Because the code for that class is auto-genearated by
xsd.exe. If you made any changes to the schema, the class will be
re-generated and the comments will be lost. This behavior is by design.

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."

Nov 22 '05 #2
Yes, your understanding is correct.
Somewhere in the source files I need to document the tables, relationships
and attributes of the dataset using xmldoc comments.

As you state, the DataSet class source code is auto-generated without
preserving changes. I understand this behaviour is by design, but where
does Microsoft recommend I put my entity-relationship documentation, without
having to put together a completely seperate document. One could argue that
ER documentation should be happening seperately because it's really the
database layer, however DataSets can have many client-side calculated fields
or extra fields to store query result sets with server side calculated or
aggregated columns...

Somewhere I need to document the mapping between a DataTable's fields and
the database tables. It seems that I can't do this without creating a
seperate document.

"Kevin Yu [MSFT]" <v-****@online.microsoft.com> wrote in message
news:$U**************@cpmsftngxa10.phx.gbl...
Hi Tolga,

First of all, I would like to confirm my understanding of your issue. From
your description, I understand that you need to preserve xml comments in
the typed DataSet class. If there is any misunderstanding, please feel free to let me know.

As far as I know, it is not recommended to add xml comments in the typed
DataSet class. Because the code for that class is auto-genearated by
xsd.exe. If you made any changes to the schema, the class will be
re-generated and the comments will be lost. This behavior is by design.

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."

Nov 22 '05 #3
Hi Tolga,

Yes, I think you have to create another seperate document to achieve this.
Sorry for the inconvenience.

Kevin Yu
=======
"This posting is provided "AS IS" with no warranties, and confers no
rights."

Nov 22 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

1
by: David | last post by:
Can you convert a strongly typed dataset to another typed dataset if the schemas are identical? Thanks in advance for any insight. David.
3
by: MC D | last post by:
I have a situation in which I have a strongly typed dataset based on the schema of a xml document. This works great, and OMG I love strongly typed datasets... ;o) However, The situation I have...
1
by: Big D | last post by:
I am having trouble understanding strongly typed datasets and XML files. I have the following schema: <xs:schema id="Pages" targetNamespace="http://asdf.org/EOBEPages.xsd"...
3
by: Duncan Welch | last post by:
I have a strongly typed dataset that returns two tables - "items" and "itemdetails". In the strongly-typed dataset designer, I've created a link (relationship) between the two tables based on a...
0
by: Mike P | last post by:
I'm using strongly typed datasets as in this MSDN article : http://msdn.microsoft.com/asp.net/reference/data/default.aspx?pull=/libr...
1
by: Mike P | last post by:
I have been trying out using strongly typed datasets in VS 2005, and I have to say that I don't like them...they produce loads of auto-generated code, and I would much rather create a single class...
0
by: Annie | last post by:
hello guys, I have created the BLL and DAL using the microsoft strongly typed datasets. There are couple of problems here: 1- The table adaptor object Insert method accepts arguments for all...
0
by: Ben | last post by:
I'm trying to apply techniques I'd normally use to pull data from SQL/Server to pull XML from SQL/Server, and I'm running into a problem. Here's what I'm doing: 1. I've built a stored...
4
by: Rachana | last post by:
Hi, I have understood Data Sets but what is meant by typed/untyped/ strongly typed datasets. Can any one explain me or suggest any site/ article, to get these concepts (and their ...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.