473,785 Members | 2,443 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

include documentation comments for object browser & Intellisence f

This is a slightly edited re-post with a (hopefully) more descriptive subject
and a bit more detail.

I'm new to C# and to newsgroups, so please bear with a possibly foolish
query. I'll try to be sensible.

The results of /// <summary> ... </summary> etc. appear immediately in the
Object Browser and in Intellisense popups, as advertised. But when I try to
get the same result with <include file='filename' path='tagpath[@name="id"]'
/>, no joy.

Having spent the better part of 2 days in a textbook-help-and-msdn search,
I'm stumped, so I've isolated the problem in a solution consisting of nothing
else.

I've ensured that the project (.csproj), class (.cs), included file (*.txt),
and xml (.XML) files are all in the same folder with the same
case-sensitive name. Further, the included
filename is correct: confirmed by mis-typing the name, building the project
and observing the Error List. Strangely, mis-typing the path leading to the
target text within the included file produces no error.

The same text works correctly when copied from the included file and pasted
ahead of the class definition with /// prefixes.

Hoping someone can help.
--
to be sharp or not to be, that is the question
Nov 16 '05 #1
0 1204

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

21
3315
by: Peter Bassett | last post by:
I have a .shtml file, that displays photos, in which I wish to pass some functionality off to an Include file for reusability purposes. Unfortunately, it's not working. Here is a portion of the .shtml file: ====== <!--#include file="/tmb8/functions.inc"--> <script type="text/javascript"> var title = "Noosa, Australia - October / November 2003"
1
3313
by: Alex VanderWoude | last post by:
I am trying to <include> some text into an XML documentation topic, but that text is stored in a file that is in a different directory than the "current" XML file. Using a relative path does not appear to work, because the base being used is the Common7\IDE directory, not my original source directory. Here is the situation: MyApp directory contains the file Form1.cs, Form1.xml, and Generic.xml. There is also a subdirectory called...
1
1554
by: Adie | last post by:
Hi, I'm starting to reuse quite a bit of my code through namespace references and would like that when I view the object in the "object browser" that I can see my comments about the method, property or whatever. All I get at the moment is the method's signature.
2
1823
by: Philippe Bertrand | last post by:
I tried following the pattern in MSDN and it just plain doesn't work. I replaced the comments for a class with an include tag but did not change any of the comments on the members of the class (without the include tag my docs were building fine). /// <include file='Command2.xml' path='MyDocs/MyMembers/*'/> public class MyClass : ... with Command2.xml looking like: <MyDocs>
1
1379
by: geoffblanduk_nospam | last post by:
Does anyone know of any classes that will load the XML documentation into some useful classes? I'm assuming there must be some somewhere as that's what the Object browser does to show summaries and comments, and Intellisense must do something similar. But I can't find anything specific in the help files. I could roll my own but would prefer to save an hour or two if it's
0
991
by: Howard Weiss | last post by:
I am writing an application which automates Excel from Managed Visual C++. I have imported the Microsoft Excel Objects COM object per KB 303871 and KB 303872. If I do this in C# or VB, the ObjectBrowser provides interfaces for the Range Object, Pivot Tables, etc. I see the following hierarchy in the Object Browser Interop.Excel Excel
0
892
by: Ralf Jablonski | last post by:
Hello, using VC++ 2003 all source code comments in front of eg. a class method has been visible in intellisense and object browser. After converting the project to whidbey, the source code comments are no longer visible. I also tried the C# style XML tags without success. Has anybody have the same problem or any hint ?
4
1367
by: Mike Morse | last post by:
Dies anyone know of a good way to document your classes. I currently use the VB commenter for VS.net 2003 but that does not provide any intellisence functionality for my objects like description and such. Also when you select tools > build comment web pages... I find these web pages to be almost useless and less than satisfactory as documentation. I would really like to know how to document my objects better.
0
1143
by: Gennaro Prota | last post by:
Hi, after several "tweaks" I think I've finally found a file layout which I like for my code (in terms of where the copyright line and the license reference go, where the vim modeline etc.). For included files, I've stuck so far to the suggestion in C++ Coding Standards which says: Don't try to be clever: Don't put any code or comments before and after the guarded portion, and stick to the standard form
0
9647
marktang
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...
0
10357
Oralloy
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...
0
10162
jinu1996
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...
1
10101
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,...
0
9959
tracyyun
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...
0
8988
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
0
6744
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();...
0
5396
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...
3
2893
bsmnconsultancy
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...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.