We need to parse out and display class documentation for certain classes from Xml documents produced during our build process (for our .Net assemblies) for certain web-service data contracts on a website?
We can use Linq2Xml and do it the hard way but I was wondering if someone's already done this?
Related
I often have to create a soap web service which needs to conform to certain documentation. In particular it is often some OTA flavour. (open travel alliance)
For example the service needs to receive OTA_HotelRateAmountNotifRQ and respond with a OTA_HotelRateAmountNotifRS. Generally the syntax of those messages can be downloaded as .xsd:
http://www.opentravel.org/2004A/OTA_HotelRateAmountNotifRQ.xsd
What I would like to do is simplify the process of creating such a service (right now I'm using XDocument and analyze/create the XML by hand).
So assuming I have access to particular XSD files, how can I automatically create corresponding code/classes, wrap them up in SOAP and use as a basis for a web service?
I hope the question makes some sense, any help would be appreciated.
You want to use the XSD to model your WSDL. Then import your WSDL into Visual Studio. This is called the top down or WSDL first approach.
If you dont have a decent WSDL editor such as Altova XML Spy or Liquid XML I would suggest you invest in one as it will make this rather easy.
See Walkthrough: Designing Application Systems by Using a Top-Down Approach for an example.
I am creating a custom SOAP parser for a C# project.
I would like to import libxml2 (a pure c library) to my project. Is this doable?
Are there any C# alternatives in .NET? Is there a C# port of libxml2?
You can use standard XmlWriter and XmlReader from System.Xml namespace which internally use Microsoft Xml Parser which is pretty fast. You can even use DOM oriented acces with System.Xml.XmlDocument or System.Xml.Linq.XDocument. Even there is System.Runtime.Remoting.SoapServices class which help you with soap message.
If you want to consume some SOAP web service, than you can easily import it and visual studio will create strong typed object for you for free without any touch to the SOAP message. You can refer to: MSDN Consuming Web Services
You may have probably allready solved this but i will add this:
I was looking for the same thing and found out there is a nuGet package for libxml2
you might find this helpful.
I need to transform RDBS to an RDF model in my project. I did some research and found that Apache Jena can be helpful. However, I am not familiar with the Java platform (I am good at C++ and average at C# programming) so I tried to download Jena .Net, only to find that it is not available.
Can you give me some suggestions to give my project a head start? Can I download Jena .Net from somewhere else?
If you only have to access your SQL database using a RDF way, have a look at D2RQ: http://d2rq.org/
The D2RQ Platform is a system for accessing relational databases as
virtual, read-only RDF graphs. It offers RDF-based access to the
content of relational databases without having to replicate it into an
RDF store.
Are you trying to make a converter from RDBS to RDF as an exercise to improve your skills on Semweb technologies or do you really need this kind of conversion for a real life project? If the latter, then you should not start with simply an RDF API. You should take a look at D2RQ, but also at what the W3C is currently defining. The RDB2RDF working group is working on two specifications, one for directly mapping RDB data to RDF, without further implication of the user (it's called the Direct Mapping) and one for specifying customised mappings, such that you can generate RDF the way you like, according to the RDF Schema you like (it's called R2RML).
At the time I'm writing, these specs are Proposed Recommendation, which is the last step before Recommendation. There are already implementations of both specs.
My application is developed to take input from text/excel files, do validations and then perform database operations. Similarily it also takes input data from database and write it into text file/excel files. I am currently using stream reader and writer class from system.io namespace for input/output from text files, but I believe there are other options available in current frameworks which will give better performance compare to approach I am currently using. I like to know what are other approaches we can use to perform such activities. Share some link for books or tutorial available for it.
What you're describing is typically referred to as ETL which is short for Extract, transform, and load.
The default ETL tool for the C# programmer is SQL Server Integration Services or SSIS because of its .NET integration. You should note that it doesn't require that either the targets or sources have SQL Database involved it just acts as the broker.
CSV Reader is a C# only solution that comes at a fairly reasonable price. This means that the context of doing the ETL is in your application. If you're writing an application where a user picks a file and loads it manually this is nice option. If you need automation you'll have to write a Windows Service or use a scheduler.
In the Open Source Space there's Rhino ETL
I'll suggest you to use gembox to perform I/O in excel files:
http://www.gemboxsoftware.com/spreadsheet/overview
For text files I believe the system.io is the best aproach...
My team and I are in the final phase of our software development project.
We are using Visual Studio to compile our project and coding in C#.
We need to build user manuals. Is there any way to generate user manuals from the comments of the application and code?
Assuming you have commented your code appropriately there are a number of third-party tools that you can use to generate documentation.
The following list is not exhaustive:
SandCastle
NDoc
Doc-O-Matic
VSdocman
Doxygen
...
I just hope your end-users are developers and you are writing some sort of API. These sort of documentation generation tool are usually only suited for internal use or external developers for which you created an API that they can use.
If your target audience was other developers, you could do something like what is mentioned in this SO post but if it is end users who aren't developers, then it isn't likely that the comments in your code are going to be all that useful to them, and if they are... then they probably aren't all that useful to the developer.
If you were using XML Documentation Commments...you could use the /doc compile option.
XML Documentation Comments
When you compile with the /doc option, the compiler will search for
all XML tags in the source code and create an XML documentation file.
To create the final documentation based on the compiler-generated
file, you can create a custom tool or use a tool such as DocFX or
Sandcastle.