Come documentare la "non-nullableness" dei tipi di riferimento in C#?

Question

In C#, le istanze dei tipi di riferimento vengono passate alle funzioni come puntatore nullable. Si consideri ad esempio:

public void f(Class classInstanceRef) 

Nella maggior parte dei casi, la funzione si aspetta un puntatore non nullo (nel 95% dei casi nella mia esperienza). Qual è il modo migliore per documentare il fatto che questa funzione si aspetta un puntatore non nullo?

Aggiornamento: grazie mille per le vostre risposte finora!

Answer 1

1) Assicurarsi che il metodo respinge ogni nullo

if (instanceRef == null) 
{ 
    throw new ArgumentNullException("instanceRef"); 
} 

2) Aggiungere

/// <exception cref="T:System.ArgumentNullException"> is thrown 
/// when <paramref name="instanceRef"/> is <c>null</c></exception> 

L'eccezione generata quando un nulla di riferimento (Nothing in Visual di base) è passato a un metodo che fa non lo accetta come argomento valido (MSDN)

Answer 2

Debug.Assert(classInstanceRef != null); 

Answer 3

In .NET 4, si avrà la possibilità di utilizzare code contracts, che hanno lo scopo proprio per questo genere di cose:

Contract.Requires(classInstanceRef != null); 

Nel frattempo, penso che una corretta documentazione e gettando un ArgumentNullException è accettabile.

Answer 4

Partenza biblioteca contratti codice: http://research.microsoft.com/en-us/projects/contracts/

Vi permette di specificare le pre-condizioni per il codice e lo hanno verificato tramite l'analisi statica del codice di base:

Contract.Requires(x ! = null); 

La biblioteca sarà incluso in .NET Framework v 4 e ci sono licenze commerciali per le versioni precedenti del framework.

Answer 5

if(classInstanceRef == null) { throw new NullReferenceException("classInstanceRef"); } 

?

///<remarks>classInstanceRef cannot be null</remarks> 

Answer 6

farei qualcosa di simile:

/// <summary> 
/// Does stuff 
/// </summary> 
/// <param name="classInstanceRef">some documentation</param> 
/// <exception cref="ArgumentNullException">Thrown when the <paramref name="classInstanceRef"/> is null.</exception> 
public void f(Class classInstanceRef) 
{ 
    if (classInstanceRef == null) 
    throw new ArgumentNullException("classInstanceRef"); 
}