Minha equipe é responsável pelo desenvolvimento de uma API para um sistema grande que também escrevemos. Precisamos fornecer um código de exemplo para que outros desenvolvedores que usam nossa API possam aprender como usá-lo. Estamos documentando o código usando os comentários do documento xml. por exemplo.

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

Em seguida, usamos o Sandcastle e criamos os arquivos de ajuda que precisamos (chm e um site on-line).

É bastante embaraçoso quando o código de exemplo não funciona, e isso geralmente ocorre porque algumas funcionalidades foram alteradas ou por um erro simples.

Alguém já fez algo assim, mas também configurou testes de unidade para serem executados no código de exemplo, para que eles trabalhem durante a compilação?