EDN Admin
Well-known member
XML Comments that should generate useful xml file from the embedded XML Comments (http://msdn.microsoft.com/en-us/library/b2s063f7.aspx) are not formatted correctly.
Am I making any of the following errors:
1. Is my creating, editting, and viewing process correct?
2. Are my XML Comments in the code formatted correctly?
3. Do I have a bad or incorrect Documents.XLS Template that cant correctly convert autogenerated XML comments file?
The code has XML Comments but the XML features are not being used so it is really cluttered. We should try to use the XML auto-generated help features in order to help us with creating an SDD. If we cant get successfully add a working XLS template to
the 2nd line of the created XML file in order to view in a web browser such as IE, perhaps we can either use a 3rd party tool (e.g., Sandcastle) or experiment on a smaller scale first using the Lab links.
I checked XML Documentation file check box in Build tab of Project Properties and specified c:testLinkedInApplicationXML.xml which I could then view in a browser but when I added a reference to an XLS Template per http://msdn.microsoft.com/en-us/library/aa290357(v=vs.71).aspx
the file was viewable in IE in a correct format (
see Figure 9).
Any idea why the Style sheet processing instruction in doc.xsl for the associated xsl fpr C# .Net did not enable me to view the XML in readable format?
Once this is explained, can we add the list of methods to the SRS in the form of a table?
Note: here are the steps that I did:
1. added c:testLinkedInApplication.xml to build property tab in project properties and built
2. viewed c:testLinkedInApplication.xml in web browser to see raw format
3. Downloaded and unziped "Document.xls" file that I found at http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx and extracted the *.xsl (the file extension was not .xslt so make sure it matches in step below) to the Project Documentation dropbox
folder
4. copied to Document.xls to c:/test on VC
5a. copied xml file to C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml
5b. added the line <?xml-stylesheet type="text/xsl Documentation.xsl"?> to C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml which allowed me to view in new format so did help but the formatting is still off somehow when viewing the
following in IE: C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml
6. viewed C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml in IE but the format is not correct
Is this because of the original XML Comments in the code or an issue with the Documentation.xsl transform file?
In the downloaded Document.xls file, I see in order F: M: F: M: ... and finally at T: at TypeofMessage which is the first line to appear in the webpage after the LinkedInApplication.
Should we check out http://msdn.microsoft.com/en-us/library/5ast78ax(v=VS.90).aspx and consider using Sandcastle to generate the help files?
View the full article
Am I making any of the following errors:
1. Is my creating, editting, and viewing process correct?
2. Are my XML Comments in the code formatted correctly?
3. Do I have a bad or incorrect Documents.XLS Template that cant correctly convert autogenerated XML comments file?
The code has XML Comments but the XML features are not being used so it is really cluttered. We should try to use the XML auto-generated help features in order to help us with creating an SDD. If we cant get successfully add a working XLS template to
the 2nd line of the created XML file in order to view in a web browser such as IE, perhaps we can either use a 3rd party tool (e.g., Sandcastle) or experiment on a smaller scale first using the Lab links.
I checked XML Documentation file check box in Build tab of Project Properties and specified c:testLinkedInApplicationXML.xml which I could then view in a browser but when I added a reference to an XLS Template per http://msdn.microsoft.com/en-us/library/aa290357(v=vs.71).aspx
the file was viewable in IE in a correct format (
see Figure 9).
Any idea why the Style sheet processing instruction in doc.xsl for the associated xsl fpr C# .Net did not enable me to view the XML in readable format?
Once this is explained, can we add the list of methods to the SRS in the form of a table?
Note: here are the steps that I did:
1. added c:testLinkedInApplication.xml to build property tab in project properties and built
2. viewed c:testLinkedInApplication.xml in web browser to see raw format
3. Downloaded and unziped "Document.xls" file that I found at http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx and extracted the *.xsl (the file extension was not .xslt so make sure it matches in step below) to the Project Documentation dropbox
folder
4. copied to Document.xls to c:/test on VC
5a. copied xml file to C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml
5b. added the line <?xml-stylesheet type="text/xsl Documentation.xsl"?> to C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml which allowed me to view in new format so did help but the formatting is still off somehow when viewing the
following in IE: C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml
6. viewed C:testLinkedInApplicationXMLwithXMLTransform2ndline.xml in IE but the format is not correct
Is this because of the original XML Comments in the code or an issue with the Documentation.xsl transform file?
In the downloaded Document.xls file, I see in order F: M: F: M: ... and finally at T: at TypeofMessage which is the first line to appear in the webpage after the LinkedInApplication.
Should we check out http://msdn.microsoft.com/en-us/library/5ast78ax(v=VS.90).aspx and consider using Sandcastle to generate the help files?
View the full article