Mi equipo es responsable del desarrollo de una API para un sistema grande que también escribimos. Necesitamos proporcionar un código de ejemplo para que otros desarrolladores que usan nuestra API puedan aprender cómo usarlo. Hemos estado documentando el código utilizando los comentarios del documento xml. p.ej.

/// <summary>Summary here</summary>
/// <example>Here is an example  <code>example code here</code> </example>
public void SomeFunction() 

Luego usamos Sandcastle y construimos los archivos de ayuda que necesitamos (chm y un sitio web en línea).

Es bastante vergonzoso cuando el código de ejemplo no funciona, y esto generalmente se debe a que algunas funciones han cambiado o se trata de un simple error.

¿Alguien ha hecho algo como esto, pero también configuró pruebas unitarias para ejecutarse en el código de ejemplo para que se sepa que funcionan durante la compilación?