I am currently working on documenting our now massive code base. I can use sandcastle to generate .chm files that contain the xml comments I have inserted into the code. My question now I guess is: What next? I would like to be able to host them on our server as a website instead of me having to pass out the documentation to the people that may need it now or in the future. I know the question is vague (I'm not 100% sure what I'm even looking for) but any tips or help in the right direction would be greatly appreciated.
The Sandcastle Help File Builder allows for output to Website via the HelpFileFormat setting. In this mode, a complete ASP.NET website is generated from the documentation. The look and feel is extremely similar to the .chm.
Related
Basically I use http://support.microsoft.com/kb/326201 for clearing the cache.
But in a article http://msdn.microsoft.com/en-us/library/windows/desktop/aa383990(v=vs.85).aspx it is mentioned that the above KB cannot be used from the server.
They asked to use WinHTTP, can anyone suggest me a way to implement this.
I searched in net but can't get any proper article for this implementation.
I am a beginner too, so find it difficult for implementing.
Please help me anyone...
Thanks in advance
For years I've been storing XML documentation inline in my source code and putting up with a "sea of green", but I recently found out about the <include file="..." path="..."/> directive that can be used in Visual Studio to move documentation into it's own XML file. Apparently intellisense will still work using this method, as will Sandcastle etc for help file generation.
I was just wondering how others are handling the "sea of green" issue where code gets buried under mounds of documentation? Do you just learn to live with it, or do you move the XML documentation into a separate file and use inline comments where code clarification might be needed?
Pros
The code file becomes a lot "cleaner".
It makes it easier to browse the code and locate a specific code block/method.
Cons
It may make the code harder for strangers to grok if there is no inline documentation.
The absence of documentation may create a tendency to forget about the XML file and not update documentation when the code changes.
http://msdn.microsoft.com/en-us/library/9h8dy30z.aspx
I just leave it inline and use these Visual Studio - Command to collapse all sections of code? commands to collapse and expand code when I'm looking through large files. In this case I think the cons outweigh the pros. Unless you and your fellow developers are extremely diligent about documentation I don't see that method working very well. Documentation is already lacking in most code bases I've seen, so increasing the difficulty of adding it, in my opinion, is a bad idea.
I have been looking around for hours trying to find a clear simple solution to my question and have yet to find a good answer. I am trying to do a URL request in flash to my NOPCommerce site. I want to pass a GET value to the my .cs file which i'll then use that value to grab specific information and return it back to flash. How would I set up the C# or asp.net side of things? If anyone could give me an example of what I am looking for I would greatly appreciate it.
I don't know if I am supposed to use a .aspx, .cs or .ascx file.
Thanks,
Brennan
I found it to be extremely simple with web services in as3. Here is a link to see what I mean
As3 Web Services
Use the HttpWebRequest class to GET the variables, do the magic and return a result by invoking the HttpWebRequest again.
Examples and usage here:
http://www.csharp-station.com/HowTo/HttpWebFetch.aspx
You have a few options for server-side communication with flash.
Flash remoting. This is the most popular because it's the most performant, but not the easiest to understand at first glance. It transfers data in a binary format. Available libraries are Weborb and Fluorine.
Web Services as mentioned in a previous post.
Ajax/JSON. I think with Flash Player 11.3, JSON decoding is native in the player now.
Straight up http request.
Sockets (not recommended for beginners)
To answer your question as you asked it, though, for all but #4, you'd be using a CS file to retrieve your data. For #4, you'd most likely be using an .aspx page, but it could be a combination of .aspx and .ascx files.
My recommendation is that you do some research on each of these methods to decide what would work best with your development environment, required level of security, and project. Then, ask specific questions about each method as necessary.
Good Luck!
For this post, I'm looking for more conceptual help than a specific technical solution (although anything helps).
Basically, I've been asked to automate an XML HTTP POST through an application layer. I've never done anything like this before, so I'm a bit confused where to even start on a high level. It would be great if someone could share with me what steps I would need to take to accomplish this task. Here is some more background information:
Currently, our company uses an application (we'll call it Program.exe) on a daily basis to design front-end interfaces with a visual editor. Once the interface is completed, Program.exe creates JSP files and submits them to the server. Unfortunately, the process of creating and sending the files takes an awfully large number of clicks, so management would like to automate this process by running a script that would take the project files from Program.exe, convert them to JSP and accurately submit them through the application layer of Program.exe to the appropriate server.
So far I have used WireShark to sniff the packets of a simple transaction using Program.exe and discovered a number of HTTP/XML POST packets that contained XML data with information like "Current File Name" "User name" and more. Curiously, all of these data items were submitted in different packets, not all in one. There are also multiple references to SOAP. (I have almost no knowledge of SOAP, except that it exists)
At this point, this is all of the information I have. I am unsure what steps I should take from here. I would really like to understand this process on a high level, so any conceptual information would be greatly appreciated.
Finally, we use C# primarily for these sorts of tasks, so if someone would like to share a technical solution feel free to use C#.
Thank you all very much.
I would tackle this by completely ignoring the expected method of solving the problem (generating an HTTP POST) and instead focusing on what the actual problem is.
What are your inputs? A bunch of JSP files by the sound of it.
What are your outputs? The same bunch of JSP files.
What has to be accomplished? Moving the inputs from one know location to another.
Now with a well defined problem, a solution is much more likely to clearly present itself.
For example, by looking at the problem I've defined I would think that XCopy would be an elegant solution to the problem.
Any time I get handed a solution and then told to go solve a certain problem, I am always highly suspicious of the tool I've been given. If they knew that this was the best solution to the problem, why didn't they do it themselves?
My advice: Find your own solution.
Hope that helps!
I've found that the more I refine a question, the better help I get.
So, to make the question as complete as possible, I'm providing this C# WPF solution created in Visual Studio 2010 Beta 2.
This solution exactly reproduces the problem I'm having, as I try to capture output from ssh.exe using the System.Diagnostics.Process object.
To reproduce this problem, right in front of your own eyes, you'll need two things:
(1) An installation of Visual Studio 2010 Beta 2.
(2) The IP address of a Linux Server that allows incoming SSH connections.
To modify this code to work, you'll probably need to be just as much a hacker as much as you are a programmer. The code is as complete as I know how to make it. It will monitor the output of almost any other command-line utility (except for ssh.exe).
If you click on my name, you can see all the previous ways I've asked this question. If you have a suggestion, but are unable to download and reproduce this problem, please submit you answers to one of those previous question instead:
I'd like to reserve this question to those who have the prerequisites to reproduce the problem, and answer it by showing how they made it work (with certain modifications).
I have read your question and I have not reproduced or fixed this issue. I however do offer some good (I hope ) advice. You have been trying to make this approach work and not succeeding, I would suggest trying a different approach.
I would look into the existing C# SSH libraries (1 2 3) which have been coded, tested, proved and will provide a much nicer interface than System.Diagnostics.Process.
I know this does not answer your question, but it could resolve your issue.