Is there a relatively straightforward way to get Sandcastle hooked into the
asp.net 2.0 development process? I have a C# app I'm developing that has code
in both the root and App_Code directories.
Sorry for the post here - only confilicting info in the various blogs.
Thanks,
Marc 9 1981
Hi Marc,
From your description, you're wondering the proper way to integrate the
Sandcastle into ASP.NET project compilation so as to generate document for
it, correct?
Based on my research, Sandcastle will accept .net assembly or xml build
document file as input to generate target help document. Thus, for ASP.NET
2.0 web application, since it is by default dynamically compiled, you need
to perform precompilation so as to generate assemblies. And use the
precompiled output assemblies as input for Sandcastle to generate output
document. For precompilation, you can consider use Web Deployment Project:
#Visual Studio 2005 Web Deployment Projects http://msdn2.microsoft.com/en-us/asp.net/aa336619.aspx
Or you can consider using the Web application project(built-in support
after install vs 2005 sp1), this project can help build vs 2003/asp.net 1.1
like web site project that has pregenerated assemblies in "bin" dir, you
can use them to generate help document:
#Visual Studio 2005 Web Application Projects http://msdn2.microsoft.com/en-us/asp.net/aa336618.aspx
Here is a msdn forum thread discussing on the same topic:
#Sand Castle with ASP.NET 2.0 Applications http://forums.microsoft.com/MSDN/Sho...07177&SiteID=1
Hope this helps.
Sincerely,
Steven Cheng
Microsoft MSDN Online Support Lead
=============== =============== =============== =====
Get notification to my posts through email? Please refer to http://msdn.microsoft.com/subscripti...ult.aspx#notif
ications.
Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at http://msdn.microsoft.com/subscripti...t/default.aspx.
=============== =============== =============== =====
This posting is provided "AS IS" with no warranties, and confers no rights.
On Mar 28, 6:55 am, stch...@online. microsoft.com (Steven Cheng[MSFT])
wrote:
Hi Marc,
From your description, you're wondering the proper way to integrate the
Sandcastle into ASP.NET project compilation so as to generate document for
it, correct?
DON'T use Sandcastle...!!
It £$%&@ BIG time!!
Use the Alpha version of NDoc for .Net 2.0 (which can be found with a
little bit of pain googling around)
..t
-- http://ajaxwidgets.com
ASP.NET 2.0 Ajax Widgets
Steven,
Sorry - still in trouble...
First, asp.net does not have project properties, so, unlike a windows app,
there's no properties section and no "build" page where you would normally
check the "doc" option and specify a doc dIRECTORY.
I did find a page talking about web apps, and added the following to my
web.config
<system.codedom >
<compilers>
<compiler language="c#;cs ;csharp" extension=".cs"
type="Microsoft .CSharp.CSharpC odeProvider, System,
Version=1.0.500 0.0, Culture=neutral , PublicKeyToken= b77a5c561934e08 9"
compilerOptions ="/doc:C:\xyz\XMLd ocs\out.xml"/>
</compilers>
</system.codedom>
Note that the doc option ends with a file name - you cannot quit at the
directory level.
When I went and did a "rebuild solution" the xml file contained information
about the last (alphabetically latest) .cs file, so I assume that the same
file was repeatedly reused during the compilation. After that, I went back
and modified a couple of .cs's and did a standard build and the file was
replaced with partial information about the files I changed.
For non web apps, you just check of the DOC option and specify a directory.
Each .cs winds up with its own .xml documentation file, which is of cours
what you need/want.
Also, in the xml file I see
<assembly>
<name>App_Web_b tqkavbn</name>
</assembly>
I know that I'm going to have to publish the site in order to get a dll, but
will it actually create a dll with that weird name?
thx
Marc
Thomas,
Have you had any success using it with ASP.NET projects??
Marc
Hi Marc,
If you're doing to do the precompilation first and generate document, you
can consider using Web Deployment project:
#Visual Studio 2005 Web Deployment Projects http://msdn2.microsoft.com/en-us/asp.net/aa336619.aspx
it can help customize the precompilation, such as specify the output
assembly's name.
In addition, if you can use the "Web application project"(like VS
2003/asp.net 1.1 project model), it also provide the "xml document" setting
in project's property dialog settings. And the assemblies are generated(in
private bin dir) when you build the project.
Sincerely,
Steven Cheng
Microsoft MSDN Online Support Lead
This posting is provided "AS IS" with no warranties, and confers no rights.
Steven,
I must be pretty dense, because this can't be that hard...
The web deployment project does not offer anything re: xml documentation in
the properties sheets. The MSBuild file does however have a MergeXmlDocs
property but this assumes that aspnet_compiler has produced these. This is
what I'm trying to get to happen.
The Web Deployment project has some nice features, but I don't think I need
any of them.
As to a Web Application project, when I start a VS2005 and attempt to creat
a new project and select "Web Application Project" I get an error box
saying...
>The project file c:\documents and settings\....\T emqsdfa.21x\WbA pp.csproj cannot be opened
The project type is not supported by this installation.
In any case, to go back to the original problem, all I'm trying to do is to
get aspnet_compiler to produce the xml files with the comments in them from
my .cs files. As noted earlier, my attempts to do this in the web.config by
specifying compilerOptions ="/doc:..." fails because it only produces one
output file and that is for the last .cs compiled.
I simply need to tell the &^%$ compiler to create an xml file for each .cs
that it compiles in the course of a build.
Marc
Thanks for your reply Joe,
yes, web deployment project doesn't provide "xml document file ..."
setting. Therefore, you need to use assembly as direct input for Sandcastle
to generate document.
For Web Application Project, are you installing it through Visual Studio
2005 SP1 or install it separately? It seems the project template file is
corrupted. You can try look at the problem file(the template in the cache
location) and try clean it or copy a correct one from other place to see
whether it works. So far, I think this project type would be the most
elegant one for your case.
Sincerely,
Steven Cheng
Microsoft MSDN Online Support Lead
This posting is provided "AS IS" with no warranties, and confers no rights.
Steven,
>>Therefore, you need to use assembly as direct input for Sandcastle to generate document
Are you saying that Sandcastle can do the whole job from the assemblies
themselves WITHOUT geting the COMMENTS.XML file extracted from the .cs files
by the compiler?? I don't think that that is the case.
I did manage to get the Web Application project template working, and as you
said, it does provide a "Generate XML" option in the property sheets.
Unfortunately, I am at the end of my development phase and have a completed
and functional Web Site project in place. The WebApp project is good for new
projects or upgrading VS2003 projects - not converting from VS2005 Web Site
projects.
I made a quick attempt of copying my files to a new WebApp project and
including them in the project. The build attempt failed, complaining about
missing connection strings coming from my datasets (XSDs). I suspect that
this is just the beginning of a series of things that would have to be fixed.
In any case, I don't want to risk porting a debugged, functioning app to a
different project type.
Its hard enough to make a living in this business without having to fight
with your tools.
Marc
Thanks for your reply Marc,
For the input of Sandcastle, I'll contact some Sandcastle project specific
engineers to confirm this.
For web applicaiton Project, yes, you can not simply copy all the content
of web site project into it because they have different page
development/compile model. Web application projecct is like VS
2003/ASP.NET1.X project.
Anyway, I'll update you if I get any new information on this.
Sincerely,
Steven Cheng
Microsoft MSDN Online Support Lead
This posting is provided "AS IS" with no warranties, and confers no rights. This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics |
by: Bruce One |
last post by:
Folks,
Is anyone stuck like me, in choosing between SandCastle (the new MS doc
support) and NDoc 2.0 framework?
Ive downloaded NDoc 2.0 but it does not compile quite well. On the other
hand, SandCastle seems to be too childish to use it for real in professional
app...
Any opinions?
|
by: Chris |
last post by:
I am using the website project for my site. How do I compile and output an
XML comments file. I have tried to publish the file to a folder C:/sand and
specify a compiler option in my web.config
compilerOptions="/doc:c:\sand\app_code.xml" /but this does work:
|
by: dami.gupta |
last post by:
I am building a chm file using sandcastle and am following
instructions on
https://blogs.msdn.com/sandcastle/archive/2006/07/29/682398.aspx
I am following all the commands which are proceeding kind of ok, until
I get to
hhc output\test.hhp
|
by: Fresno Bob |
last post by:
I've just started using Sandcastle CTP in conjunction with GUI tool to
generate the scripts. Has it been integrated into 2008 yet or is there some
kind of add-in for VS 2005. Where is Microsoft going with this?
|
by: silpa |
last post by:
Hi,
I have creates a c# Class Library project in Visual Studio 2008.I have created a class with XML Comments in it.
I need to generate a "chm"(compiled html file) help file for this.
In the VS 2008 command promp , I began by compiling the C# file and extracting the /// comments.
csc /t:library /doc:comments.xml test.cs
An xml file and dll are created.
| |
by: silpa |
last post by:
Hi,
For Generating Website for API documentation using Sandcastle
I opened Powershell window and gave the command
scbuild –framework 2.0 –sources Class1.dll,comments.xml –BuildWebsite
An error is thrown which is as follows:
|
by: praveen1983 |
last post by:
hi
i want to know the sancastle tool and how to start with that.. how that tool works ..
|
by: Dennis |
last post by:
Please point me to a more appropriate group for this question if I have
misposted.
I am playing around with Sandcastle and the Sandcastle Help File Builder
gui for a class library I have built with vb.net. I like the website
output it produces, but it can't be uploaded to a *nix webserver because
it uses asp. If there another tool I can use to generate msdn style
documentation that doesn't use asp?
TIA,
|
by: ssnaik84 |
last post by:
Hello,
I have a ASP.NET website (not web application) source code.
I want to generate its code documentation through any tool.
I checked SandCastle, but, it generates documentation for only ASP.NET web application, I guess. Because, it needs namespaces and in ASP.NET website, we dont have.
I checked GhostDoc also. but, I could not install it, since, I'm using VS 2008 Express edition.
Please let me know, how to proceed.
|
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: 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: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
|
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: conductexam |
last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one.
At the time of converting from word file to html my equations which are in the word document file was convert into image.
Globals.ThisAddIn.Application.ActiveDocument.Select();...
|
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: adsilva |
last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
| |
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...
| |