Отдельная документация по коду

Question

Я не знаю, возможно ли это, но мне интересно, есть ли способ сохранить код и документацию в отдельных файлах, но все равно работать так же, как и с встроенной документацией.

Answer 1

Да, вы можете хранить комментарии документации XML во внешних файлах и включать их в свои файлы кода, используя тег <include>.

the MSDN documentation От:

Тег позволяет ссылаться на комментарии в другом файле, описывающие типы и элементы в исходном коде. Это альтернатива размещению комментариев документации непосредственно в файле исходного кода. Поместив документацию в отдельный файл, вы можете применить исходный код к документации отдельно от исходного кода. У одного человека может быть извлечен файл исходного кода, а у кого-то еще может быть файл документации.

Например, вы можете иметь файл с именем xml_include_tag.doc, содержащий следующую документацию комментарии:

<MyDocs> 

    <MyMembers name="test"> 
     <summary> 
      The summary for this type. 
     </summary> 
    </MyMembers> 

    <MyMembers name="test2"> 
     <summary> 
      The summary for this other type. 
     </summary> 
    </MyMembers> 

</MyDocs> 

И вы должны включить эту документацию в файле кода, как так:

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' /> 
class Test 
{ 
    static void Main() 
    { 
    } 
} 

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' /> 
class Test2 
{ 
    public void Test() 
    { 
    } 
}