doc[protocol]: 修改文档注释

This commit is contained in:
godotg
2022-07-29 22:39:47 +08:00
parent 1dbae44e59
commit aadabbbc80
223 changed files with 233 additions and 240 deletions
@@ -10,7 +10,7 @@ namespace zfoo {
// 复杂的对象
// 包括了各种复杂的结构,数组,List,Set,Map
//
// @author jaysunxiao
// @author godotg
// @version 3.0
class ComplexObject : public IPacket {
public:
@@ -7,7 +7,7 @@
namespace zfoo {
// @author jaysunxiao
// @author godotg
// @version 3.0
class NormalObject : public IPacket {
public:
@@ -6,7 +6,7 @@
namespace zfoo {
// @author jaysunxiao
// @author godotg
// @version 3.0
class ObjectA : public IPacket {
public:
@@ -5,7 +5,7 @@
namespace zfoo {
// @author jaysunxiao
// @author godotg
// @version 3.0
class ObjectB : public IPacket {
public:
@@ -5,7 +5,7 @@
namespace zfoo {
// @author jaysunxiao
// @author godotg
// @version 3.0
class SimpleObject : public IPacket {
public:
@@ -7,7 +7,7 @@ namespace CsProtocol
// 复杂的对象
// 包括了各种复杂的结构,数组,List,Set,Map
//
// @author jaysunxiao
// @author godotg
// @version 3.0
public class ComplexObject : IPacket
{
@@ -4,7 +4,7 @@ using CsProtocol.Buffer;
namespace CsProtocol
{
// @author jaysunxiao
// @author godotg
// @version 3.0
public class NormalObject : IPacket
{
@@ -4,7 +4,7 @@ using CsProtocol.Buffer;
namespace CsProtocol
{
// @author jaysunxiao
// @author godotg
// @version 3.0
public class ObjectA : IPacket
{
@@ -4,7 +4,7 @@ using CsProtocol.Buffer;
namespace CsProtocol
{
// @author jaysunxiao
// @author godotg
// @version 3.0
public class ObjectB : IPacket
{
@@ -4,7 +4,7 @@ using CsProtocol.Buffer;
namespace CsProtocol
{
// @author jaysunxiao
// @author godotg
// @version 3.0
public class SimpleObject : IPacket
{
@@ -1,7 +1,7 @@
# 复杂的对象
# 包括了各种复杂的结构,数组,List,Set,Map
#
# @author jaysunxiao
# @author godotg
# @version 3.0
# byte类型,最简单的整形
@@ -1,4 +1,4 @@
# @author jaysunxiao
# @author godotg
# @version 3.0
var a # byte
@@ -1,4 +1,4 @@
# @author jaysunxiao
# @author godotg
# @version 3.0
var a # int
@@ -1,4 +1,4 @@
# @author jaysunxiao
# @author godotg
# @version 3.0
var flag # boolean
@@ -1,4 +1,4 @@
# @author jaysunxiao
# @author godotg
# @version 3.0
var c # int
@@ -37,7 +37,7 @@ import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class SpeedTest {
@@ -22,7 +22,7 @@ import org.junit.Ignore;
import org.junit.Test;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class ByteBufUtilsTest {
@@ -19,7 +19,7 @@ import java.util.Map;
import java.util.Objects;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class MyObjectA implements IPacket {
@@ -18,7 +18,7 @@ import com.zfoo.protocol.IPacket;
import java.util.Objects;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class MyObjectB implements IPacket {
@@ -20,7 +20,7 @@ import java.util.Map;
import java.util.Set;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class MyPacket implements IPacket {
@@ -14,7 +14,7 @@
package com.zfoo.protocol.javassist;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
@@ -14,7 +14,7 @@
package com.zfoo.protocol.javassist;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class B {
@@ -14,7 +14,7 @@
package com.zfoo.protocol.javassist;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class C {
@@ -14,7 +14,7 @@
package com.zfoo.protocol.javassist;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class D {
@@ -14,7 +14,7 @@
package com.zfoo.protocol.javassist;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class Hello {
@@ -14,7 +14,7 @@
package com.zfoo.protocol.javassist;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public interface IDGet {
@@ -27,7 +27,7 @@ import java.util.Map;
import java.util.Set;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
@Ignore
@@ -22,7 +22,7 @@ import java.util.Map;
* protobuf的测试类型
* 包括了各种复杂的结构,对象,map
*
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class ObjectA implements IPacket {
@@ -17,7 +17,7 @@ import com.baidu.bjf.remoting.protobuf.annotation.Protobuf;
import com.zfoo.protocol.IPacket;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class ObjectB implements IPacket {
@@ -21,7 +21,7 @@ import java.util.Map;
/**
* ObjectC的测试类型
*
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class ObjectC implements IPacket {
@@ -20,7 +20,7 @@ import java.util.Map;
import java.util.Set;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class NormalObject implements IPacket {
@@ -19,7 +19,7 @@ import java.util.Map;
import java.util.Objects;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class ObjectA implements IPacket {
@@ -18,7 +18,7 @@ import com.zfoo.protocol.IPacket;
import java.util.Objects;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class ObjectB implements IPacket {
@@ -16,7 +16,7 @@ package com.zfoo.protocol.packet;
import com.zfoo.protocol.IPacket;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class SimpleObject implements IPacket {
@@ -16,7 +16,7 @@ package com.zfoo.protocol.util;
import org.junit.Test;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class AssertionUtilsTest {
@@ -21,7 +21,7 @@ import java.io.IOException;
import java.util.Set;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
@Ignore
@@ -21,7 +21,7 @@ public class DomUtilsTest {
private static final String XML_WITH_HEAD = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\" ?>\n" +
"\n" +
"<protocols author=\"jaysunxiao\">\n" +
"<protocols author=\"godotg\">\n" +
" <module id=\"1\" name=\"common\" minId=\"1000\" maxId=\"2000\">\n" +
" <protocol id=\"1000\" location=\"com.zfoo.test.CM_Int\"/>\n" +
" <protocol id=\"2000\" location=\"com.zfoo.test.SM_Int\"/>\n" +
@@ -32,7 +32,7 @@ public class DomUtilsTest {
" </module>\n" +
"</protocols>";
private static final String XML_OF_STANDARD_TEXT = "<protocols author=\"jaysunxiao\">\n" +
private static final String XML_OF_STANDARD_TEXT = "<protocols author=\"godotg\">\n" +
" <module id=\"1\" name=\"common\" minId=\"1000\" maxId=\"2000\">\n" +
" <protocol id=\"1000\" location=\"com.zfoo.test.CM_Int\"/>\n" +
" <protocol id=\"2000\" location=\"com.zfoo.test.SM_Int\"/>\n" +
@@ -46,13 +46,13 @@ public class DomUtilsTest {
@Test
public void testXmlWithHead() {
var protos = DomUtils.string2Object(XML_WITH_HEAD, XmlProtocols.class);
Assert.assertEquals("jaysunxiao", protos.getAuthor());
Assert.assertEquals("godotg", protos.getAuthor());
}
@Test
public void testXmlOfStandardText() {
var protos = DomUtils.string2Object(XML_OF_STANDARD_TEXT, XmlProtocols.class);
Assert.assertEquals("jaysunxiao", protos.getAuthor());
Assert.assertEquals("godotg", protos.getAuthor());
}
}
@@ -26,7 +26,7 @@ import java.util.*;
public class JsonUtilTest {
public static String id = "\"id\":\"1000\"";
public static String name = "\"name\":\"jaysunxiao\"";
public static String name = "\"name\":\"godotg\"";
public static String sex = "\"sex\":\"man\"";
public static String age = "\"age\":22";
public static String list = "\"list\":[1,2,3]";
@@ -39,7 +39,7 @@ public class JsonUtilTest {
public void string2Object() {
User user = JsonUtils.string2Object(userJson, User.class);
Assert.assertEquals(user.getId(), "1000");
Assert.assertEquals(user.getName(), "jaysunxiao");
Assert.assertEquals(user.getName(), "godotg");
Assert.assertEquals(user.getSex(), "man");
Assert.assertEquals(user.getList().size(), 3);
Assert.assertEquals(user.getMap().size(), 3);
@@ -49,7 +49,7 @@ public class JsonUtilTest {
public void object2String() {
User user = new User();
user.setId("1000");
user.setName("jaysunxiao");
user.setName("godotg");
user.setSex("man");
user.setAge(22);
//数组,链表,list
@@ -23,7 +23,7 @@ import java.util.function.Consumer;
import java.util.function.Predicate;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
@@ -17,7 +17,7 @@ import org.junit.Assert;
import org.junit.Test;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/
public class StringUtilTest {
@@ -17,7 +17,7 @@ import java.util.List;
import java.util.Map;
/**
* @author jaysunxiao
* @author godotg
* @version 3.0
*/ //@JsonIgnoreProperties({"name", "age"})//可以将它看做是@JsonIgnore的批量操作
public class User {
@@ -1,7 +1,7 @@
// 复杂的对象
// 包括了各种复杂的结构,数组,List,Set,Map
//
// @author jaysunxiao
// @author godotg
// @version 3.0
const ComplexObject = function(a, aa, aaa, aaaa, b, bb, bbb, bbbb, c, cc, ccc, cccc, d, dd, ddd, dddd, e, ee, eee, eeee, f, ff, fff, ffff, g, gg, ggg, gggg, h, hh, hhh, hhhh, jj, jjj, kk, kkk, l, ll, lll, llll, lllll, m, mm, mmm, mmmm, mmmmm, s, ss, sss, ssss, sssss, myCompatible, myObject) {
// byte类型,最简单的整形
@@ -1,4 +1,4 @@
// @author jaysunxiao
// @author godotg
// @version 3.0
const NormalObject = function(a, aaa, b, c, d, e, f, g, jj, kk, l, ll, lll, llll, m, mm, s, ssss) {
this.a = a; // byte
@@ -1,4 +1,4 @@
// @author jaysunxiao
// @author godotg
// @version 3.0
const ObjectA = function(a, m, objectB) {
this.a = a; // int
@@ -1,4 +1,4 @@
// @author jaysunxiao
// @author godotg
// @version 3.0
const ObjectB = function(flag) {
this.flag = flag; // boolean
@@ -1,4 +1,4 @@
// @author jaysunxiao
// @author godotg
// @version 3.0
const SimpleObject = function(c, g) {
this.c = c; // int
@@ -1,7 +1,7 @@
-- 复杂的对象
-- 包括了各种复杂的结构,数组,List,Set,Map
--
-- @author jaysunxiao
-- @author godotg
-- @version 3.0
local ComplexObject = {}
@@ -1,4 +1,4 @@
-- @author jaysunxiao
-- @author godotg
-- @version 3.0
local NormalObject = {}
@@ -1,4 +1,4 @@
-- @author jaysunxiao
-- @author godotg
-- @version 3.0
local ObjectA = {}
@@ -1,4 +1,4 @@
-- @author jaysunxiao
-- @author godotg
-- @version 3.0
local ObjectB = {}
@@ -1,4 +1,4 @@
-- @author jaysunxiao
-- @author godotg
-- @version 3.0
local SimpleObject = {}
+1 -1
View File
@@ -19,7 +19,7 @@ namespace Test.Editor.LuaTest
var luaEnv = new LuaEnv();
var luaDebugBuilder = new StringBuilder();
// Rider的断点调试
// luaDebugBuilder.Append("package.cpath = package.cpath .. ';C:/Users/jaysunxiao/AppData/Roaming/JetBrains/Rider2021.1/plugins/EmmyLua/classes/debugger/emmy/windows/x64/?.dll'").Append(FileUtils.LS);
// luaDebugBuilder.Append("package.cpath = package.cpath .. ';C:/Users/godotg/AppData/Roaming/JetBrains/Rider2021.1/plugins/EmmyLua/classes/debugger/emmy/windows/x64/?.dll'").Append(FileUtils.LS);
// luaDebugBuilder.Append("local dbg = require('emmy_core')").Append(FileUtils.LS);
// luaDebugBuilder.Append("dbg.tcpListen('localhost', 9966)").Append(FileUtils.LS);
// luaDebugBuilder.Append("dbg.waitIDE()").Append(FileUtils.LS);
@@ -1,10 +1,9 @@
import ObjectA from './ObjectA';
import ObjectB from './ObjectB';
// 复杂的对象
// 包括了各种复杂的结构,数组,List,Set,Map
//
// @author jaysunxiao
// @author godotg
// @version 3.0
class ComplexObject {
@@ -1,7 +1,6 @@
import ObjectA from './ObjectA';
import ObjectB from './ObjectB';
// @author jaysunxiao
// @author godotg
// @version 3.0
class NormalObject {
@@ -1,6 +1,6 @@
import ObjectB from './ObjectB';
// @author jaysunxiao
// @author godotg
// @version 3.0
class ObjectA {
@@ -1,5 +1,5 @@
// @author jaysunxiao
// @author godotg
// @version 3.0
class ObjectB {
@@ -1,5 +1,5 @@
// @author jaysunxiao
// @author godotg
// @version 3.0
class SimpleObject {