XML-documentation for a namespace

前端 未结 7 1181
自闭症患者
自闭症患者 2020-12-14 05:21

Would you write xml-doc for a namespace? And if yes, how and where?

I would think, if it is possible, maybe an almost empty file like this:

/// 

        
7条回答
  •  情深已故
    2020-12-14 06:05

    NDoc supports this by recognising a special NamespaceDoc class located in each namespace, and using the documentation from that. I haven't tried it, but Sandcastle appears to support the same trick.

    Edit: For example:

    namespace Some.Namespace
    {
        /// 
        /// This namespace contains stuff
        /// 
        public static class NamespaceDoc
        {
        }
    }
    

提交回复
热议问题