I have generated my XML documentation.
now what ?
because the XML file is not quite human friendly....
I tryed NDoc but it bugged using my XML files....
and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
no luck ;-(
any tips ? ideas ? or links ?
(yeah, I know, I could do it myself, but you know always the same problem
that the not quite finished project should be delivered yesterday :-) 4 3101
Hi Lloyd,
Are you looking for a documentation of your code similar to MSDN help. I
mean class, members , properties like that. Using NDOC you can generate the
help file. Only thing is that you have to mention the entire comemnts to
your cod including ///summary, ///remarks etc. In NDOC there are some
options while generating the doc. So that you can hide the private members.
Let me know what is the error that you are getting from NDOC utility.
Regards
Sreejumon[MVP]
DOTNET makes IT happen
"Lloyd Dupont" <ll***@galador. net> wrote in message
news:OV******** *****@TK2MSFTNG P09.phx.gbl... I have generated my XML documentation. now what ? because the XML file is not quite human friendly....
I tryed NDoc but it bugged using my XML files.... and I also tryed to look for 'XML translator (C#)' on MSDN & Google.. no luck ;-(
any tips ? ideas ? or links ?
(yeah, I know, I could do it myself, but you know always the same problem that the not quite finished project should be delivered yesterday :-)
well when I said I had no luck with NDoc I mean I Had no luck with NDOC.
so I already tryed and was unsucessfull with it ....
"Sreejumon[MVP]" <sr********@hot mail.com> wrote in message
news:eS******** ********@TK2MSF TNGP12.phx.gbl. .. Hi Lloyd,
Are you looking for a documentation of your code similar to MSDN help. I mean class, members , properties like that. Using NDOC you can generate
the help file. Only thing is that you have to mention the entire comemnts to your cod including ///summary, ///remarks etc. In NDOC there are some options while generating the doc. So that you can hide the private
members. Let me know what is the error that you are getting from NDOC utility.
Regards Sreejumon[MVP] DOTNET makes IT happen
"Lloyd Dupont" <ll***@galador. net> wrote in message news:OV******** *****@TK2MSFTNG P09.phx.gbl... I have generated my XML documentation. now what ? because the XML file is not quite human friendly....
I tryed NDoc but it bugged using my XML files.... and I also tryed to look for 'XML translator (C#)' on MSDN & Google.. no luck ;-(
any tips ? ideas ? or links ?
(yeah, I know, I could do it myself, but you know always the same
problem that the not quite finished project should be delivered yesterday :-)
Lloyd,
I would say that NDoc is best available tool for documenting. I have been
using it now almost one year.
Sreejumon,
Nice tool, however it can't handle properly methods whos names differs only
by case.
Ron
"Lloyd Dupont" <ll***@galador. net> wrote in message
news:#T******** *****@tk2msftng p13.phx.gbl... well when I said I had no luck with NDoc I mean I Had no luck with NDOC. so I already tryed and was unsucessfull with it ....
"Sreejumon[MVP]" <sr********@hot mail.com> wrote in message news:eS******** ********@TK2MSF TNGP12.phx.gbl. .. Hi Lloyd,
Are you looking for a documentation of your code similar to MSDN help. I mean class, members , properties like that. Using NDOC you can generate the help file. Only thing is that you have to mention the entire comemnts to your cod including ///summary, ///remarks etc. In NDOC there are some options while generating the doc. So that you can hide the private members. Let me know what is the error that you are getting from NDOC utility.
Regards Sreejumon[MVP] DOTNET makes IT happen
"Lloyd Dupont" <ll***@galador. net> wrote in message news:OV******** *****@TK2MSFTNG P09.phx.gbl... I have generated my XML documentation. now what ? because the XML file is not quite human friendly....
I tryed NDoc but it bugged using my XML files.... and I also tryed to look for 'XML translator (C#)' on MSDN & Google.. no luck ;-(
any tips ? ideas ? or links ?
(yeah, I know, I could do it myself, but you know always the same problem that the not quite finished project should be delivered yesterday :-)
Hi Lloyd,
Have you tried the following?
In the Visual Studio IDE, go to "Tools | Build Comment Web Pages...". It
will create HTML documentation for you.
--------------------
| From: "Lloyd Dupont" <ll***@galador. net>
| Subject: XML documentation
| Date: Fri, 25 Jul 2003 08:57:42 +1000
|
| I have generated my XML documentation.
| now what ?
| because the XML file is not quite human friendly....
|
| I tryed NDoc but it bugged using my XML files....
| and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
| no luck ;-(
|
| any tips ? ideas ? or links ?
|
| (yeah, I know, I could do it myself, but you know always the same problem
| that the not quite finished project should be delivered yesterday :-)
- Zhanyong Wan
Visual Studio and .NET Setup
This posting is provided "AS IS" with no warranties, and confers no rights.
Use of included samples (if any) is subject to the terms specified at http://www.microsoft.com/info/cpyright.htm This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics |
by: Daniel R. Smorey Jr. |
last post by:
I'm looking for a good place for Python documentation. I'm really lost
on why it's so hard to find anything when it comes to me looking up a
particular function in Python. My example would be the split() function
of the string module. Why can't I just go to www.python.org and click
on Search and then type in split and it bring me to the split() function
of the string module? Why does it have to be so hard? This is what I
get when I...
|
by: Steve |
last post by:
posted on: comp.lang.python
emailed to: docs@python.org
I have a suggestion/request that will, I think, improve the Python
documentation.
Currently, the Python documentation in HTML format is stored at URLs
that change with each new release of Python. That is, for example, the
documentation for the os module is at
http://python.org/doc/2.3/lib/module-os.html for release 2.3 of Python,
|
by: Christopher J. Bottaro |
last post by:
This post is just the culmination of my thoughts and discussions with my
coworkers on Python. If you are not interested, please skip over it.
At my work, we are developing a product from scratch. It is completely
modular and the modules communicate via SOAP. Because of that, we can
implement individual modules in any language of our choosing (so long as
they have good SOAP libs). I chose to do all mine in Python because I'm a
huge...
|
by: Jeff Levinson [mcsd] |
last post by:
I'm an architect for a very large fortune 100 company and
we still struggle with the best balance. However, I use a
couple of simple guidelines that have worked very well
for me in almost all cases (there have been some times
when I've lived to regret some decisions).
Use case work flows are the bread and butter of the
documentation and all others flow from them. Each of the
high-level processes needs to be broken down into lower
level...
|
by: Almoni |
last post by:
Hi,
I have a few .xsd files that include each other in the following way:
<!-- lets call the main schema file AA.xsd and it includes BB.xsd
inside it -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified" attributeFormDefault="unqualified">
| |
by: Ole Hanson |
last post by:
I would like to be able to generate documentation for a custom configuration
file (xml) to enable future support engineers to understand applicable
values to the various elements inside the configuration file. (see below for
sample).
Does any program exist (like NDoc) that is able to generate MSDN like
documentation?
|
by: Cameron Laird |
last post by:
QOTW: "Python makes it easy to implement algorithms." - casevh
"Most of the discussion of immutables here seems to be caused by
newcomers wanting to copy an idiom from another language which doesn't
have immutable variables. Their real problem is usually with binding,
not immutability." - Mike Meyer
Among the treasures available in The Wiki is the current
copy of "the Sorting min-howto":
|
by: innovasys |
last post by:
TORQUAY, DEVON, UK - Innovasys announced the release of Document! X
5, the fifth version of the documentation solution of choice for
developers using Microsoft Visual Studio or the .NET Framework.
Document! X 5 automatically produces professional quality technical
documentation and on-line help for Microsoft .NET Framework assemblies
(.NET Framework 1.0, 1.1 and 2.0 are all supported), COM components and
controls, Visual Basic source code,...
|
by: nicolasfr |
last post by:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
That's why I have started a collaborative project to make a user
contributed Python documentation. The wiki is online here:
http://www.pythondocs.info
|
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, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look !
Part I. Meaning of...
|
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 effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it.
First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
| |
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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed.
This is as boiled down as I can make it.
Here is my compilation command:
g++-12 -std=c++20 -Wnarrowing bit_field.cpp
Here is the code in...
|
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth.
The Art of Business Website Design
Your website is...
|
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 protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
|
by: isladogs |
last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM).
In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules.
He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms.
Adolph will...
|
by: TSSRALBI |
last post by:
Hello
I'm a network technician in training and I need your help.
I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs.
The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols.
I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
|
by: 6302768590 |
last post by:
Hai team
i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
| |
by: bsmnconsultancy |
last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...
| |