v2019.2.12

jiandandan · Feb 11, 2019 · 3041d4e · 3041d4e
1 parent 1437357
commit 3041d4e
Show file tree

Hide file tree

Showing 14 changed files with 170 additions and 32 deletions.
diff --git a/AutumnBox.GUI/Properties/AssemblyInfo.cs b/AutumnBox.GUI/Properties/AssemblyInfo.cs
@@ -65,6 +65,6 @@
 // 可以指定所有值，也可以使用以下所示的 "*" 预置版本号和修订号
 // 方法是按如下所示使用“*”: :
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2019.2.4")]
-[assembly: AssemblyFileVersion("2019.2.4")]
+[assembly: AssemblyVersion("2019.2.12")]
+[assembly: AssemblyFileVersion("2019.2.12")]
 [assembly: NeutralResourcesLanguage("zh-CN")]
diff --git a/AutumnBox.Logging.Shared/LoggerExtension.cs b/AutumnBox.Logging.Shared/LoggerExtension.cs
@@ -3,35 +3,63 @@
 
 namespace AutumnBox.Logging
 {
+    /// <summary>
+    /// ILogger的拓展方法
+    /// </summary>
     public static class LoggerExtension
     {
-        [Conditional("DEBUG")]
+        /// <summary>
+        /// 写出一条Debug级别日志
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="message"></param>
         public static void Debug(this ILogger logger, object message)
         {
             logger.Log(nameof(Debug), message);
         }
-
-        [Conditional("DEBUG")]
+        /// <summary>
+        /// 写出一条带有异常信息的Debug级别日志,秋之盒调试模式时可用
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="message"></param>
+        /// <param name="e"></param>
         public static void Debug(this ILogger logger, object message, Exception e)
         {
             logger.Log(nameof(Debug), message, e);
         }
-
+        /// <summary>
+        /// 写出一条仅包含异常信息的日志
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="e"></param>
         public static void Exception(this ILogger logger, Exception e)
         {
             logger.Log(nameof(Exception), e);
         }
-
+        /// <summary>
+        /// 写出一条Info级别日志
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="message"></param>
         public static void Info(this ILogger logger, object message)
         {
             logger.Log(nameof(Info), message);
         }
-
+        /// <summary>
+        /// 写出一条警告级别日志
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="message"></param>
         public static void Warn(this ILogger logger, object message)
         {
             logger.Log(nameof(Warn), message);
         }
-
+        /// <summary>
+        /// 写出一条带有异常信息的警告级别日志
+        /// </summary>
+        /// <param name="logger"></param>
+        /// <param name="message"></param>
+        /// <param name="e"></param>
         public static void Warn(this ILogger logger, object message, Exception e)
         {
             Trace.WriteLine("wtf!!!");

diff --git a/AutumnBox.Logging.Shared/LoggerFactory.cs b/AutumnBox.Logging.Shared/LoggerFactory.cs
@@ -19,7 +19,7 @@ public static ILogger Auto<TCategoryClass>()
             return new Internal.LoggerImpl(typeof(TCategoryClass).Name);
         }
         /// <summary>
-        /// Auto
+        /// 传入字符串的Category名,并获取日志器
         /// </summary>
         /// <param name="categoryName"></param>
         /// <returns></returns>
@@ -39,7 +39,8 @@ public static ILogger<TCategoryClass> AutoT<TCategoryClass>()
         /// <summary>
         /// 通过需要的日志器类型,自动构造
         /// </summary>
-        /// <param name="loggerType"></param>
+        /// <param name="loggerType">日志器类型</param>
+        /// <param name="defaultCategory">日志器类型错误时的基础Category类型</param>
         /// <returns></returns>
         public static object Auto(Type loggerType, Type defaultCategory = null)
         {

diff --git a/AutumnBox.Logging.Shared/Management/HeritableStationAttribute.cs b/AutumnBox.Logging.Shared/Management/HeritableStationAttribute.cs
@@ -2,6 +2,9 @@
 
 namespace AutumnBox.Logging.Management
 {
+    /// <summary>
+    /// 当ILogStation标记时,将可以继承前任ILogStaion的日志信息
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class)]
     public class HeritableStationAttribute : Attribute
     {

diff --git a/AutumnBox.Logging.Shared/Management/ILog.cs b/AutumnBox.Logging.Shared/Management/ILog.cs
@@ -1,14 +1,27 @@
 using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace AutumnBox.Logging.Management
 {
+    /// <summary>
+    /// 日志数据结构
+    /// </summary>
     public interface ILog
     {
+        /// <summary>
+        /// 日志时间
+        /// </summary>
         DateTime Time { get; }
+        /// <summary>
+        /// 日志级别
+        /// </summary>
         string Level { get; }
+        /// <summary>
+        /// 日志发送者/类别/标签
+        /// </summary>
         string Category { get; }
+        /// <summary>
+        /// 日志具体信息
+        /// </summary>
         string Message { get; }
     }
 }
diff --git a/AutumnBox.Logging.Shared/Management/ILoggingStation.cs b/AutumnBox.Logging.Shared/Management/ILoggingStation.cs
@@ -2,9 +2,19 @@
 
 namespace AutumnBox.Logging.Management
 {
+    /// <summary>
+    /// 日志管理站,实现此接口的类,可用于管理日志
+    /// </summary>
     public interface ILoggingStation
     {
+        /// <summary>
+        /// 已处理的日志
+        /// </summary>
         IEnumerable<ILog> Logs { get; }
+        /// <summary>
+        /// 处理一个日志
+        /// </summary>
+        /// <param name="log"></param>
         void Log(ILog log);
     }
 }
diff --git a/AutumnBox.Logging.Shared/Management/LoggingManager.cs b/AutumnBox.Logging.Shared/Management/LoggingManager.cs
@@ -1,11 +1,10 @@
 using AutumnBox.Logging.Internal;
-using System.IO;
 using System.Reflection;
 
 namespace AutumnBox.Logging.Management
 {
     /// <summary>
-    /// 
+    /// 日志系统管理器
     /// </summary>
     public static class LoggingManager
     {

diff --git a/AutumnBox.Logging.Shared/SLogger.Generic.cs b/AutumnBox.Logging.Shared/SLogger.Generic.cs
@@ -5,47 +5,80 @@
 
 namespace AutumnBox.Logging
 {
+    /// <summary>
+    /// 泛型的静态日志器,可通过传入的泛型信息自动设置Category,秋之盒调试模式时可用
+    /// </summary>
+    /// <typeparam name="TCategory"></typeparam>
     public static class SLogger<TCategory>
     {
         private static string Category => typeof(TCategory).Name;
 
+        /// <summary>
+        /// 写出一条Debug级别日志
+        /// </summary>
+        /// <param name="message"></param>
         public static void Debug(object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Debug), Category, message));
         }
 
+        /// <summary>
+        /// 写出一条带有异常信息的Debug级别日志,秋之盒调试模式时可用
+        /// </summary>
+        /// <param name="message"></param>
+        /// <param name="e"></param>
         public static void Debug(object message, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Debug), Category, message, e));
         }
 
+        /// <summary>
+        /// 写出一条CDebug级别的日志信息,当你的程序集使用非DEBUG编译时,对此函数的调用会被忽略
+        /// </summary>
+        /// <param name="message"></param>
         [Conditional("DEBUG")]
         public static void CDebug(object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(CDebug), Category, message));
         }
-
+        /// <summary>
+        /// 写出一条带异常CDebug级别的日志信息,当你的程序集使用非DEBUG编译时,对此函数的调用会被忽略
+        /// </summary>
+        /// <param name="message"></param>
         [Conditional("DEBUG")]
         public static void CDebug(object message, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(CDebug), Category, message, e));
         }
-
+        /// <summary>
+        /// 写出一条仅包含异常信息的日志
+        /// </summary>
+        /// <param name="e"></param>
         public static void Exception(Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Exception), Category, e));
         }
-
+        /// <summary>
+        /// 写出一条Info级别日志
+        /// </summary>
+        /// <param name="message"></param>
         public static void Info(object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Info), Category, message));
         }
-
+        /// <summary>
+        /// 写出一条警告级别日志
+        /// </summary>
+        /// <param name="message"></param>
         public static void Warn(object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Warn), Category, message));
         }
-
+        /// <summary>
+        /// 写出一条带有异常信息的警告级别日志
+        /// </summary>
+        /// <param name="message"></param>
+        /// <param name="e"></param>
         public static void Warn(object message, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Warn), Category, message, e));

diff --git a/AutumnBox.Logging.Shared/SLogger.cs b/AutumnBox.Logging.Shared/SLogger.cs
@@ -10,43 +10,80 @@ namespace AutumnBox.Logging
     /// </summary>
     public static class SLogger
     {
+        /// <summary>
+        /// 写出一条Debug级别的日志信息,开启秋之盒调试模式才可显示
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
         public static void Debug(object category, object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Debug), category, message));
         }
-
+        /// <summary>
+        /// 写出一条带异常信息的Debug级别的日志信息,开启秋之盒调试模式才可显示
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
+        /// <param name="e"></param>
         public static void Debug(object category, object message, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Debug), category, message, e));
         }
 
+        /// <summary>
+        /// 写出一条CDebug级别的日志信息,当你的程序集使用非DEBUG编译时,对此函数的调用会被忽略
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
         [Conditional("DEBUG")]
         public static void CDebug(object category, object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(CDebug), category, message));
         }
 
+        /// <summary>
+        /// 写出一条带异常CDebug级别的日志信息,当你的程序集使用非DEBUG编译时,对此函数的调用会被忽略
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
         [Conditional("DEBUG")]
         public static void CDebug(object category, object message, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(CDebug), category, message, e));
         }
-
+        /// <summary>
+        /// 写出一条仅包含异常信息的日志
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="e"></param>
         public static void Exception(object category, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Exception), category, e));
         }
-
+        /// <summary>
+        /// 写出一条Info级别日志
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
         public static void Info(object category, object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Info), category, message));
         }
-
+        /// <summary>
+        /// 写出一条警告级别日志
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
         public static void Warn(object category, object message)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Warn), category, message));
         }
-
+        /// <summary>
+        /// 写出一条带有异常信息的警告级别日志
+        /// </summary>
+        /// <param name="category"></param>
+        /// <param name="message"></param>
+        /// <param name="e"></param>
         public static void Warn(object category, object message, Exception e)
         {
             LoggingManager.LogStation.Log(new Log(nameof(Warn), category, message, e));

diff --git a/AutumnBox.Logging/AutumnBox.Logging.csproj b/AutumnBox.Logging/AutumnBox.Logging.csproj
@@ -21,6 +21,7 @@
     <DefineConstants>DEBUG;TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Debug\AutumnBox.Logging.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -29,6 +30,17 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\AutumnBox.Logging.xml</DocumentationFile>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'SDK|AnyCPU'">
+    <OutputPath>bin\SDK\</OutputPath>
+    <DefineConstants>TRACE;SDK</DefineConstants>
+    <Optimize>true</Optimize>
+    <DebugType>pdbonly</DebugType>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <ErrorReport>prompt</ErrorReport>
+    <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
+    <DocumentationFile>bin\SDK\AutumnBox.Logging.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="System" />

diff --git a/AutumnBox.Logging/Properties/AssemblyInfo.cs b/AutumnBox.Logging/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // 可以指定所有值，也可以使用以下所示的 "*" 预置版本号和修订号
 //通过使用 "*"，如下所示:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("2019.2.12")]
+[assembly: AssemblyFileVersion("2019.2.12")]
diff --git a/AutumnBox.OpenFramework/AutumnBox.OpenFramework.nuspec b/AutumnBox.OpenFramework/AutumnBox.OpenFramework.nuspec
@@ -19,5 +19,7 @@
   <files>
     <file src="bin\Sdk\AutumnBox.Basic.dll" target="lib/net461"/>
   <file src="bin\Sdk\AutumnBox.Basic.xml" target="lib/net461"/>
+    <file src="bin\Sdk\AutumnBox.Logging.xml" target="lib/net461"/>
+    <file src="bin\Sdk\AutumnBox.Logging.dll" target="lib/net461"/>
   </files>
 </package>
diff --git a/AutumnBox.OpenFramework/Properties/AssemblyInfo.cs b/AutumnBox.OpenFramework/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // 可以指定所有值，也可以使用以下所示的 "*" 预置版本号和修订号
 //通过使用 "*"，如下所示:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("8.27")]
-[assembly: AssemblyFileVersion("8.27")]
+[assembly: AssemblyVersion("8.28")]
+[assembly: AssemblyFileVersion("8.28")]