none
DLL <summary> RRS feed

  • 問題

  • 一個類別庫專案,讓其他方案專案使用並查詢中繼資料時

    Q1.請問該如何向.net的一樣可以顯示下圖這樣的資訊,而不是只是在使用function時顯示摘要

    2019年7月3日 上午 09:13

解答

  • 應用使用 /// 格式,而非註解格式,這樣就能在其他人參考時也顯示摘要:https://docs.microsoft.com/zh-tw/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments

    理直氣和,切記。

    個人

    2019年7月3日 上午 09:35
  • 讓我釐清一下您「像.net的一樣可以在中繼資料顯示資訊」,你是指在呼叫時顯示那些資訊嗎?

    就我所知,那些是「註解」不是什麼中繼資料,在 Debug 模式會包含在 DLL 裡面,這樣方便其他開發人員進行除錯。在 Release 模式的 DLL 預設會被最佳化給移除。


    理直氣和,切記。

    個人

    • 已標示為解答 StuBoo 2019年7月9日 上午 05:31
    2019年7月4日 下午 03:00
  • 一個類別庫專案,讓其他方案專案使用並查詢中繼資料時

    Q1.請問該如何向.net的一樣可以顯示下圖這樣的資訊,而不是只是在使用function時顯示摘要

    你说的这个东西叫xml注释文档。它本身是不包含在代码中的,而是存放在单独的xml文件中。要生成这个文件,你需要右键点击项目选【属性】。然后:

    要Release就在Release中勾选XML文档文件,要Debug就在Debug中勾选,都要就分别设置。

    生成之后将dll和同名xml文件一同复制到需要这个dll的项目中,然后再引用这个dll,就能看到你说的这个东西了。如果以前引用过,需要取消引用,再重新引用,然后卸载项目,再重新加载。如果是分发dll给别人用,那么需要连同xml文件一起分发,然后使用者需要将dll和xml这两个同名文件放在一起再引用。

    • 已標示為解答 StuBoo 2019年7月9日 上午 05:31
    2019年7月4日 下午 06:49

所有回覆

  • 應用使用 /// 格式,而非註解格式,這樣就能在其他人參考時也顯示摘要:https://docs.microsoft.com/zh-tw/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments

    理直氣和,切記。

    個人

    2019年7月3日 上午 09:35
  • 應用使用 /// 格式,而非註解格式,這樣就能在其他人參考時也顯示摘要:https://docs.microsoft.com/zh-tw/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments

    理直氣和,切記。

    個人

        public class Class1
        {
            /// <summary>
            /// test1
            /// return : if par1 == par2 return true
            /// </summary>
            /// <param name="par1">par1</param>
            /// <param name="par2">par2</param>
            /// <returns></returns>
            public static bool TestFunction1(int par1, int par2)
            {
                return par1 == par2;
            }
    
        }

    只能在呼叫函式時看到註解

    我想要的是像.net的一樣可以在中繼資料顯示資訊

    2019年7月4日 上午 03:56
  • 讓我釐清一下您「像.net的一樣可以在中繼資料顯示資訊」,你是指在呼叫時顯示那些資訊嗎?

    就我所知,那些是「註解」不是什麼中繼資料,在 Debug 模式會包含在 DLL 裡面,這樣方便其他開發人員進行除錯。在 Release 模式的 DLL 預設會被最佳化給移除。


    理直氣和,切記。

    個人

    • 已標示為解答 StuBoo 2019年7月9日 上午 05:31
    2019年7月4日 下午 03:00
  • 一個類別庫專案,讓其他方案專案使用並查詢中繼資料時

    Q1.請問該如何向.net的一樣可以顯示下圖這樣的資訊,而不是只是在使用function時顯示摘要

    你说的这个东西叫xml注释文档。它本身是不包含在代码中的,而是存放在单独的xml文件中。要生成这个文件,你需要右键点击项目选【属性】。然后:

    要Release就在Release中勾选XML文档文件,要Debug就在Debug中勾选,都要就分别设置。

    生成之后将dll和同名xml文件一同复制到需要这个dll的项目中,然后再引用这个dll,就能看到你说的这个东西了。如果以前引用过,需要取消引用,再重新引用,然后卸载项目,再重新加载。如果是分发dll给别人用,那么需要连同xml文件一起分发,然后使用者需要将dll和xml这两个同名文件放在一起再引用。

    • 已標示為解答 StuBoo 2019年7月9日 上午 05:31
    2019年7月4日 下午 06:49