From 9ffd50c8ed26e0be4ccdb500f261132c19600e96 Mon Sep 17 00:00:00 2001
From: hutongqing <hutongqing@hnkhzn.com>
Date: 星期二, 03 九月 2024 15:34:59 +0800
Subject: [PATCH] 增加注释
---
WIDESEAWCS_Server/WIDESEAWCS_Communicator/BaseCommunicator.cs | 46 ++++++++++++++++++++++++++++++++++++++--------
1 files changed, 38 insertions(+), 8 deletions(-)
diff --git a/WIDESEAWCS_Server/WIDESEAWCS_Communicator/BaseCommunicator.cs b/WIDESEAWCS_Server/WIDESEAWCS_Communicator/BaseCommunicator.cs
index d028bd8..2d53b02 100644
--- a/WIDESEAWCS_Server/WIDESEAWCS_Communicator/BaseCommunicator.cs
+++ b/WIDESEAWCS_Server/WIDESEAWCS_Communicator/BaseCommunicator.cs
@@ -30,8 +30,14 @@
{
}
+ /// <summary>
+ /// 鏃ュ織璁板綍瀹炰緥瀵硅薄
+ /// </summary>
public abstract ILogNet LogNet { get; }
+ /// <summary>
+ /// 璁惧鍚嶇О
+ /// </summary>
public abstract string Name { get; }
/// <summary>
@@ -64,7 +70,6 @@
/// </summary>
/// <typeparam name="T">璇诲彇鏁版嵁鐨勭被鍨嬫硾鍨嬨��</typeparam>
/// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
- /// <param name="length">瑕佽鍙栫殑鏁版嵁闀垮害銆�</param>
/// <returns>璇诲彇鍒扮殑鏁版嵁锛屽鏋滆鍙栧け璐ュ垯鍙兘杩斿洖null鎴栨姏鍑哄紓甯搞��</returns>
public abstract T Read<T>(string address);
@@ -81,16 +86,16 @@
/// </summary>
/// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
/// <param name="data">瑕佸啓鍏ョ殑鏁版嵁銆�</param>
- /// <returns>濡傛灉鍐欏叆鎴愬姛鍒欒繑鍥瀟rue锛屽惁鍒欒繑鍥瀎alse銆�</returns>
+ /// <returns>濡傛灉鍐欏叆鎴愬姛鍒欒繑鍥瀟rue锛屽惁鍒欐姏鍑哄紓甯搞��</returns>
public abstract bool Write(string address, byte[] data);
/// <summary>
- ///
+ /// 鍚慞LC鍐欏叆鏁版嵁銆�
/// </summary>
- /// <typeparam name="T"></typeparam>
- /// <param name="address"></param>
- /// <param name="value"></param>
- /// <returns></returns>
+ /// <typeparam name="T">璇诲彇鏁版嵁鐨勭被鍨嬫硾鍨嬨��</typeparam>
+ /// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
+ /// <param name="value">瑕佸啓鍏ョ殑鏁版嵁銆�</param>
+ /// <returns>濡傛灉鍐欏叆鎴愬姛鍒欒繑鍥瀟rue锛屽惁鍒欐姏鍑哄紓甯搞��</returns>
public abstract bool Write<T>(string address, T value) where T : notnull;
/// <summary>
@@ -99,16 +104,41 @@
/// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
/// <param name="dataType">瑕佸啓鍏ョ殑鏁版嵁绫诲瀷銆�</param>
/// <param name="value">瑕佸啓鍏ョ殑鏁版嵁銆�</param>
- /// <returns>濡傛灉鍐欏叆鎴愬姛鍒欒繑鍥瀟rue锛屽け璐ュ垯鎶涘嚭鑷畾涔夐�氳寮傚父銆�</returns>
+ /// <returns>濡傛灉鍐欏叆鎴愬姛鍒欒繑鍥瀟rue锛屽け璐ュ垯鎶涘嚭寮傚父銆�</returns>
/// <exception cref="CommunicationException"></exception>
public abstract bool WriteObj(string address, string dataType, object value);
+ /// <summary>
+ /// 绛夊緟鎸囧畾鍦板潃鐨勬硾鍨嬬被鍨嬪�间负鎸囧畾鐨勫��
+ /// </summary>
+ /// <typeparam name="T">鎸囧畾鐨勫�肩殑绫诲瀷娉涘瀷銆�</typeparam>
+ /// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
+ /// <param name="readInterval">璇诲彇鐨勯鐜囥��</param>
+ /// <param name="waitTimeout">绛夊緟鐨勮秴鏃舵椂闂达紝濡傛灉瓒呮椂鏃堕棿涓�-1鐨勮瘽锛屽垯鏄棤鏈熼檺绛夊緟銆�</param>
+ /// <param name="value">绛夊緟妫�娴嬬殑鍊�</param>
+ /// <returns>鏄惁绛夊緟鎴愬姛鐨勭粨鏋滃璞★紝涓�鏃﹂�氫俊澶辫触锛屾垨鏄瓑寰呰秴鏃跺氨杩斿洖澶辫触銆傚惁鍒欒繑鍥炴垚鍔燂紝骞跺憡鐭ヨ皟鐢ㄦ柟绛夊緟浜嗗涔呫��</returns>
public abstract OperateResult<TimeSpan> Wait<T>(string address, int readInterval, int waitTimeout, T value) where T : struct;
+ /// <summary>
+ /// 璇诲彇鑷畾涔夌殑鏁版嵁绫诲瀷锛岄渶瑕佺户鎵胯嚜IDataTransfer鎺ュ彛锛岃繑鍥炰竴涓柊鐨勭被鍨嬬殑瀹炰緥瀵硅薄銆�
+ /// </summary>
+ /// <typeparam name="T">鑷畾涔夌殑鏁版嵁绫诲瀷娉涘瀷銆�</typeparam>
+ /// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
+ /// <returns>鎴愬姛杩斿洖鑷畾涔夌被鍨嬫暟鎹紝澶辫触鎶涘嚭寮傚父銆�</returns>
public abstract T ReadCustomer<T>(string address) where T : IDataTransfer, new();
+ /// <summary>
+ /// 鍐欏叆鑷畾涔夌被鍨嬬殑鏁版嵁锛岃绫诲瀷蹇呴』缁ф壙鑷狪DataTransfer鎺ュ彛銆�
+ /// </summary>
+ /// <typeparam name="T">鑷畾涔夌殑鏁版嵁绫诲瀷娉涘瀷銆�</typeparam>
+ /// <param name="address">婧愬湴鍧�锛屽叿浣撴牸寮忓彇鍐充簬浣跨敤鐨勫伐涓氬崗璁��</param>
+ /// <param name="value">瑕佸啓鍏ユ暟鎹��</param>
+ /// <returns>濡傛灉鍐欏叆鎴愬姛鍒欒繑鍥瀟rue锛屽け璐ュ垯鎶涘嚭寮傚父銆�</returns>
public abstract bool WriteCustomer<T>(string address, [NotNull] T value) where T : IDataTransfer, new();
+ /// <summary>
+ /// 閲婃斁瀵硅薄璧勬簮鐨勬帴鍙ｃ��
+ /// </summary>
public abstract void Dispose();
}
}
--
Gitblit v1.9.3