Click here to Skip to main content
14,937,556 members
Please Sign up or sign in to vote.
2.00/5 (1 vote)
See more:
I have been alwyas asked by my senior team members to write the word document for all the methods they add in the Webservice.

Some times 2-3 developer write new methods and develop a webservice that goes live in a day or two.

When it comes to documenting all the XML files in word document that takes time to explain every method and detail of each XML element and attributes used in XML.


Also,this is we do in word document for our clients so they can read and understand XML elements.

My only question is what are the alternative ways of doing this quickly.

I mean what are the alternativ ways of doing XML explanation for users.

I would assume there must be a software or some other automated way of generation the user document.

This question may be confusing caause I am still in new in the orgnanisation,so please help me.

Thanks.
Posted
Comments
[no name] 19-Jul-12 22:52pm
   
I think that you are talking about Doxygen, http://www.stack.nl/~dimitri/doxygen/
Sergey Alexandrovich Kryukov 19-Jul-12 23:58pm
   
From the developer's standpoint, MS Word is the lamer's format for office rats, not quite for documenting. They usually use XML, HTML or something else.
--SA
Sergey Alexandrovich Kryukov 19-Jul-12 23:59pm
   
What's the development tool?
--SA

1 solution

I think they mean this:
http://msdn.microsoft.com/en-us/library/x4sa0ak0.aspx[^]

And if Im not mistaken if you change the docx files to .zip insted youll see a lot of xml files. Maybe you could paste the whole XML file in the zip and change the extention again?
   
Comments
   
I would appreciate it very much, if OP told us what's the development tool and it was something where Visual Studio XML documentation could be used. Anyway, having documentation separate from development is quite sloppy, non-professional way, not even mentioning Word format.
--SA
Kenneth Haugland 20-Jul-12 12:28pm
   
Me too :)

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)




CodeProject, 20 Bay Street, 11th Floor Toronto, Ontario, Canada M5J 2N8 +1 (416) 849-8900