Hi,
Within my project, I've got a number of classes in separate files.
When I point at the name of a class in the file in which it is defined,
it shows the <summary> information for the class in a tooltip. But
when I point at the name of a class in some other file (still in the
same project), it just shows "class " and the name of the class. I
looked into generating an XML file, but it produced a bunch of errors
because I don't have comments for every single method of every single
class (none, actually, for the methods). Is the lack of an XML file
why it can't display class comments in tooltips and intellisense?
Thanks,
--Carl
2  5000  ca***********@g mail.com wrote: Hi,
Within my project, I've got a number of classes in separate files.
When I point at the name of a class in the file in which it is
defined, it shows the <summary> information for the class in a
tooltip. But when I point at the name of a class in some other file
(still in the same project), it just shows "class " and the name of
the class. I looked into generating an XML file, but it produced a
bunch of errors because I don't have comments for every single method
of every single class (none, actually, for the methods). Is the lack
of an XML file why it can't display class comments in tooltips and
intellisense? Thanks,
--Carl
Did you REbuild the project? If you just "build" then you will get a compiler
warning stating that the documentation files will not be updated.
So try a rebuild of (at least) the project. This should recreate the xml files.
It is not a problem if you didn't comment everything.
By the way: you don't get "errors" about missing comments, those
are "warnings". The code will work just as well without those comments
as with them.
Hans Kesting
Hi, Hans, By the way: you don't get "errors" about missing
comments, those are "warnings". The code will work
just as well without those comments
Thank you, but I've got the option set to "Treat all warnings as
errors" - and unfortunately it seems to apply to XML generation as well
as compilation. I think I'll just pass on the XML generation, but
thanks for the info.
Peace,
--Carl This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics | |
by: Sam |
last post by:
I have an extended class in a dll and have put summaries for each method like this
/// <summary>
/// Removes all occurences of a given object.
/// </summary>
The problem is that when I see my methods in the intellisense, the summary shows up only within the namespace and if I use my classes and methods in other projects, I don’t see my summaries, only the summaries of the base class which is a .NET original class. How come?
|
by: news.bellatlantic.net |
last post by:
I added these comments "///" (below is an example) to help the developers
use the classes and methods I am adding the library. When I instantiate an
object in the same project I get help from the comments in the IDE. However
if I add the library to another project I don't get the help. How can I make
sure I pass the help around? Do you have any information on how I generate
the XML and/or where I can find it to include it in a distribution?...
|
by: Mark Siffer |
last post by:
Does anyone know why when you have something like
public enum MyEnum {
///<summary>first item..blah blah blah</summary>
a = 0,
b = 1,
c = 2
}
and you run from the vs ide Toos-->Build Comment Web Pages
|
by: Edward Diener |
last post by:
I really do not understand the difference between the <summary> and <value>
XML document tags for a property. Why would one use one as opposed to the
other for a property, and when would one use both ?
|
by: Paul |
last post by:
Hi,
Does anyone know how to get Intellisense in VB (VS2003) to display the
content of the <summary> attribute as it does in C#?
I have put the following in code with no luck ...
' <summary>
' Returns a String Object Containing DB ConnectionString
' </summary>
| | |
by: Bruno Piovan |
last post by:
Hi,
I got a example code and there are some
'/ <Summary>
'/ bla bla bla bla bla
'/</Summary>
what does that means???
thanks
|
by: Ambuj |
last post by:
Can anyone please help me understand why this is not working?!?!
I have got this code in a C# Web service project, the project compiles
correctly but I can't see the description when I access the Web Service from
a ASP.Net web project...
/// <summary>
/// Some text
/// </summary>
|
by: |
last post by:
Is there a setting/configuration that will open a new cs file WITHOUT
"<summary> ... </summary>" and "// ... //TODO: .. //"?
Thanks.
Haji
|
by: Arne Garvander |
last post by:
How do I add a summary remark to a C# class?
--
Arne Garvander
(I program VB.Net for fun and C# to get paid.)
|
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: 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: 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...
|
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: 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
| |
