Skip to main content

​
CloudNimble.DotNetDocs.Tests.Shared Namespace

Root namespace providing core test infrastructure and sample implementations for documentation scenarios.

​
📊 Namespace Overview

​
🎯 Types in this Namespace

DotNetDocsTestBase

Base Class • Extends BreakdanceMSTestBaseCore test infrastructure for documentation generation tests. Provides utilities for working with assembly documentation.
public class DotNetDocsTestBase

SampleClass

Class • Simple example implementationDemonstrates basic class structure with properties for documentation examples.
public class SampleClass

​
📁 Sub-Namespaces

AccessModifiers

Examples demonstrating different access modifier patterns1 Type • MixedAccessClass

BasicScenarios

Common programming patterns and scenarios6 Types • Inheritance, Properties, Methods

EdgeCases

Special cases and edge scenarios for documentation4 Types • Documentation variations

Parameters

Parameter variation examples and patterns1 Type • ParameterVariations

​
💡 Quick Examples

using CloudNimble.DotNetDocs.Tests.Shared;

public class MyTest : DotNetDocsTestBase
{
    public void TestDocumentation()
    {
        // Get the test assembly documentation
        var assembly = GetTestsDotSharedAssembly();
        
        // Access the project path constant
        var path = DotNetDocsTestBase.projectPath;
        
        Console.WriteLine($"Assembly: {assembly.AssemblyName}");
    }
}

​
📊 Type Statistics

2
Direct Types
4
Sub-namespaces
12
Total Types

​
🔍 Type Details

​
DotNetDocsTestBase Members

  • projectPath (string) - Constant defining the project path
  • GetTestsDotSharedAssembly() - Returns DocAssembly with test assembly documentation
  • Constructor - Default constructor initializing the base class

​
SampleClass Members

  • Name (string) - Gets or sets the name of the sample

​
🚀 Common Usage Patterns

1

Extend DotNetDocsTestBase

Create test classes that inherit from DotNetDocsTestBase for documentation testing
2

Use Sample Classes

Leverage SampleClass and sub-namespace types for example scenarios
3

Explore Patterns

Check sub-namespaces for specific patterns like inheritance, parameters, and edge cases

Assembly Overview

Back to assembly

Basic Scenarios

Common patterns

Edge Cases

Special scenarios
Pro Tip: This namespace serves as the entry point for all test scenarios. Explore the sub-namespaces for specific pattern examples.