funktionsbeschreibung in C# und C++/CLI **gelöst**

Destiniy

Hi Leute,

in C# kann ich ja zu den Funktionen eine Beschreibung definieren die dann im VS angezeigt wird in dem ich 3 /// mache.

Wie geht das in C++/CLI damit ich die Beschreibung dann angezeigt bekomme unter C#

MfG

EXDW

gibts nicht
schau mal unter
tools-options-text editor-c#-advance-XML Documentation Comments
das gibts bei C++ nicht
wuerde mich auch wundern - in c++ ist das intellisense, automatic formatting usw alles deutlich engeschraenkter gegenueber c# (dafuer gibts visual assist x)

theta

Er redet von C++/CLI, da ist die IntelliSense IMO dieselbe wie bei C#.

theta

Xml Doc für C++/CLI:
http://msdn.microsoft.com/en-us/library/ms177226.aspx

BTW: Für C++/CLI Fragen benutze bitte das entsprechende Forum!

Destiniy

kann den Thread dann mal ein Moderator verschieben.

ich weiß jetzt wie es gemacht wird man mußte nur die Generierung des der XML einschalten. (http://geekswithblogs.net/Podwysocki/archive/2006/05/17/78718.aspx)

jetzt noch eine Frage wie bekomme ich so etwas hin?

/// <summary>
	/// array<tTest> ^aTest
	/// </summary>

wie muss ich < und > ersetzen damit ich sie dann angezeigt bekomme?

MfG

Destiniy

mit

/// <summary>
    /// array&lt;tTest&gt; ^aTest
    /// </summary>

geht es. HTML sei dank

MfG

EXDW

komisch
in summary pack ich immer eine beschreibung was die klasse macht
der return gehoert nach
// <returns></returns> - meiner meinung nach

ich mach das in meiner library immer so:

/// <summary>
/// Converts a given GUID to its name
/// </summary>
/// <param name="guid">[string] to GUID which have to be converted</param>
/// <exception cref="SDK:...">[ConvertException] Calls if the GUID is invalid</exception>
/// <returns>[string] The name for the GUID</returns>
public string GetNameByGuid(string guid)
{
    IResult result = _comDatabase.GetNameByGuid(guid);
    if (result.Error != null)
        throw new ConvertException(result.Error.Message);
    return result.Data as string;
}

wenn man dann daraus eine help datei generieren laesst - sind alle parameter und werte schoen ausgefuellt sodass man alles noetige schnell sieht
(der code ist natuerlich hier nur pseudo, solch eine methode hab ich nicht)