197 lines
5.8 KiB
HTML
197 lines
5.8 KiB
HTML
<!-- saved from url=(0014)about:internet --><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
|
<html>
|
|
<!-- Standard Head Part -->
|
|
<head>
|
|
<title>NUnit - Description</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
|
|
<meta http-equiv="Content-Language" content="en-US">
|
|
<link rel="stylesheet" type="text/css" href="nunit.css">
|
|
<link rel="shortcut icon" href="favicon.ico">
|
|
</head>
|
|
<!-- End Standard Head Part -->
|
|
|
|
<body>
|
|
|
|
<!-- Standard Header for NUnit.org -->
|
|
<div id="header">
|
|
<a id="logo" href="http://www.nunit.org"><img src="img/logo.gif" alt="NUnit.org" title="NUnit.org"></a>
|
|
<div id="nav">
|
|
<a href="http://www.nunit.org">NUnit</a>
|
|
<a class="active" href="index.html">Documentation</a>
|
|
</div>
|
|
</div>
|
|
<!-- End of Header -->
|
|
|
|
<div id="content">
|
|
|
|
<script language="JavaScript" src="codeFuncs.js" ></script> <!-- Do it this way for IE -->
|
|
|
|
<h3>Description (NUnit 2.4)</h3>
|
|
|
|
<p>The Description attribute is used to apply descriptive text to a Test,
|
|
TestFixture or Assembly. The text appears in the XML output file and is
|
|
shown in the Test Properties dialog.</p>
|
|
|
|
<h4>Example:</h4>
|
|
|
|
<div class="code">
|
|
|
|
<div class="langFilter">
|
|
<a href="javascript:Show('DD1')" onmouseover="Show('DD1')"><img src="img/langFilter.gif" width="14" height="14" alt="Language Filter"></a>
|
|
<div id="DD1" class="dropdown" style="display: none;" onclick="Hide('DD1')">
|
|
<a href="javascript:ShowCS()">C#</a><br>
|
|
<a href="javascript:ShowVB()">VB</a><br>
|
|
<a href="javascript:ShowMC()">C++</a><br>
|
|
<a href="javascript:ShowJS()">J#</a><br>
|
|
</div>
|
|
</div>
|
|
|
|
<pre class="cs">[assembly: Description("Assembly description here")]
|
|
|
|
namespace NUnit.Tests
|
|
{
|
|
using System;
|
|
using NUnit.Framework;
|
|
|
|
[TestFixture, Description("Fixture description here")]
|
|
public class SomeTests
|
|
{
|
|
[Test, Description("Test description here")]
|
|
public void OneTest()
|
|
{ /* ... */ }
|
|
}
|
|
}
|
|
</pre>
|
|
<pre class="vb"><assembly: Description("Assembly description here")>
|
|
|
|
Imports System
|
|
Imports Nunit.Framework
|
|
|
|
Namespace Nunit.Tests
|
|
|
|
<TestFixture(), Description("Fixture description here")>_
|
|
Public Class SomeTests
|
|
<Test(), Description("Test description here")>_
|
|
Public Sub OneTest()
|
|
' ...
|
|
End Sub
|
|
End Class
|
|
End Namespace
|
|
</pre>
|
|
<pre class="mc">[assembly:Description("Assembly description here")]
|
|
|
|
#using <Nunit.Framework.dll>
|
|
using namespace System;
|
|
using namespace NUnit::Framework;
|
|
|
|
namespace NUnitTests
|
|
{
|
|
[TestFixture, Description("Fixture description here")]
|
|
public __gc class SomeTests
|
|
{
|
|
[Test, Description("Test description here")]
|
|
void OneTest();
|
|
};
|
|
}
|
|
|
|
#include "cppsample.h"
|
|
|
|
namespace NUnitTests {
|
|
// ...
|
|
}
|
|
</pre>
|
|
|
|
<pre class="js">/** @assembly NUnit.Framework.Description("Assembly description here") */
|
|
|
|
package NUnit.Tests;
|
|
|
|
import System.*;
|
|
import NUnit.Framework.TestFixture;
|
|
|
|
|
|
/** @attribute NUnit.Framework.TestFixture() */
|
|
/** @attribute NUnit.Framework.Description("Fixture description here") */
|
|
public class SomeTests
|
|
{
|
|
/** @attribute NUnit.Framework.Test() */
|
|
/** @attribute NUnit.Framework.Description("Test description here") */
|
|
public void OneTest()
|
|
{ /* ... */ }
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
<p><b>Note:</b> The Test and TestFixture attributes continue to support an
|
|
optional Description property. The Description attribute should be used for
|
|
new applciations. If both are used, the Description attribute takes precedence.</p>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<!-- Submenu -->
|
|
<div id="subnav">
|
|
<ul>
|
|
<li><a href="index.html">NUnit 2.5.9</a></li>
|
|
<ul>
|
|
<li><a href="getStarted.html">Getting Started</a></li>
|
|
<li><a href="assertions.html">Assertions</a></li>
|
|
<li><a href="constraintModel.html">Constraints</a></li>
|
|
<li><a href="attributes.html">Attributes</a></li>
|
|
<ul>
|
|
<li><a href="category.html">Category</a></li>
|
|
<li><a href="combinatorial.html">Combinatorial</a></li>
|
|
<li><a href="culture.html">Culture</a></li>
|
|
<li><a href="datapoint.html">Datapoint(s)</a></li>
|
|
<li id="current"><a href="description.html">Description</a></li>
|
|
<li><a href="exception.html">Exception</a></li>
|
|
<li><a href="explicit.html">Explicit</a></li>
|
|
<li><a href="ignore.html">Ignore</a></li>
|
|
<li><a href="maxtime.html">Maxtime</a></li>
|
|
<li><a href="pairwise.html">Pairwise</a></li>
|
|
<li><a href="platform.html">Platform</a></li>
|
|
<li><a href="property.html">Property</a></li>
|
|
<li><a href="random.html">Random</a></li>
|
|
<li><a href="range.html">Range</a></li>
|
|
<li><a href="repeat.html">Repeat</a></li>
|
|
<li><a href="requiredAddin.html">RequiredAddin</a></li>
|
|
<li><a href="requiresMTA.html">Requires MTA</a></li>
|
|
<li><a href="requiresSTA.html">Requires STA</a></li>
|
|
<li><a href="requiresThread.html">Requires Thread</a></li>
|
|
<li><a href="sequential.html">Sequential</a></li>
|
|
<li><a href="setCulture.html">SetCulture</a></li>
|
|
<li><a href="setup.html">Setup</a></li>
|
|
<li><a href="setupFixture.html">SetupFixture</a></li>
|
|
<li><a href="suite.html">Suite</a></li>
|
|
<li><a href="teardown.html">Teardown</a></li>
|
|
<li><a href="test.html">Test</a></li>
|
|
<li><a href="testCase.html">TestCase</a></li>
|
|
<li><a href="testCaseSource.html">TestCaseSource</a></li>
|
|
<li><a href="testFixture.html">TestFixture</a></li>
|
|
<li><a href="fixtureSetup.html">TestFixtureSetUp</a></li>
|
|
<li><a href="fixtureTeardown.html">TestFixtureTearDown</a></li>
|
|
<li><a href="theory.html">Theory</a></li>
|
|
<li><a href="timeout.html">Timeout</a></li>
|
|
<li><a href="values.html">Values</a></li>
|
|
<li><a href="valueSource.html">ValueSource</a></li>
|
|
</ul>
|
|
<li><a href="runningTests.html">Running Tests</a></li>
|
|
<li><a href="extensibility.html">Extensibility</a></li>
|
|
<li><a href="releaseNotes.html">Release Notes</a></li>
|
|
<li><a href="samples.html">Samples</a></li>
|
|
<li><a href="license.html">License</a></li>
|
|
</ul>
|
|
</ul>
|
|
</div>
|
|
<!-- End of Submenu -->
|
|
|
|
|
|
<!-- Standard Footer for NUnit.org -->
|
|
<div id="footer">
|
|
Copyright © 2010 Charlie Poole. All Rights Reserved.
|
|
</div>
|
|
<!-- End of Footer -->
|
|
|
|
</body>
|
|
</html>
|