C# (CSharp) MeaningfulBlock示例

示例#1

        public void NoCheckFollowedByConvertExample()
        {
            const string inputString =
                @"This is our summary
	BEGIN EX NOCHECK
	 weight  name   layer   lower   upper
	END EX
	 Blend weights blah blah 
	CONVERTEXAMPLE
	BEGIN EX
		animation.weight = 0.5;
	END EX"    ;
            var derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(3, derivedModel.TextBlocks.Count);

            var example1 = derivedModel.TextBlocks[0];

            Assert.IsTrue(example1 is ExampleBlock);
            Assert.IsTrue((example1 as ExampleBlock).IsNoCheck);
            VerifyExample(derivedModel, 0, @"	 weight  name   layer   lower   upper
");
            VerifyDescription(derivedModel, 1, @"	 Blend weights blah blah");

            var example2 = derivedModel.TextBlocks[2];

            Assert.IsTrue(example2 is ExampleBlock);
            Assert.IsFalse((example2 as ExampleBlock).IsNoCheck);
            VerifyExample(derivedModel, 2, @"		animation.weight = 0.5;
");
        }

示例#2

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MemberWithOnlyReturnValue()
 {
     const string inputString = "@return retval";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.IsNotNull(derivedModel.ReturnDoc);
     Assert.AreEqual("retval", derivedModel.ReturnDoc.Doc);
 }

示例#3

        public void EmptyMember()
        {
            const string inputString   = "";
            var          expectedModel = new MeaningfulBlock(inputString);

            Assert.IsTrue(expectedModel.IsEmpty());
        }

示例#4

        public void MemberWithOnlyReturnValue()
        {
            const string inputString  = "@return retval";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.IsNotNull(derivedModel.ReturnDoc);
            Assert.AreEqual("retval", derivedModel.ReturnDoc.Doc);
        }

示例#5

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MemberWithOnlySummary()
 {
     const string inputString = "This is our summary";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.AreEqual(inputString, derivedModel.Summary);
     Assert.AreEqual(0, derivedModel.TextBlocks.Count);
     Assert.AreEqual(0, derivedModel.Parameters.Count);
 }

示例#6

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MemberWithSummaryAndDescription()
 {
     const string inputString = @"This is our summary
     Some more text";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.AreEqual("This is our summary", derivedModel.Summary);
     Assert.AreEqual(1, derivedModel.TextBlocks.Count);
     Assert.AreEqual("Some more text", derivedModel.TextBlocks[0].Text);
 }

示例#7

        public void MemberWithOnlySummary()
        {
            const string inputString  = "This is our summary";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual(inputString, derivedModel.Summary);
            Assert.AreEqual(0, derivedModel.TextBlocks.Count);
            Assert.AreEqual(0, derivedModel.Parameters.Count);
        }

示例#8

        public void MemberWithSummaryAndReturn()
        {
            const string inputString  = @"This is our summary
@return stupid stuff";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(0, derivedModel.Parameters.Count);
            Assert.AreEqual("stupid stuff", derivedModel.ReturnDoc.Doc);
        }

示例#9

        public void MemberWithSummaryAndParam()
        {
            const string inputString  = @"This is our summary
@param label Label in front of the label field";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(1, derivedModel.Parameters.Count);
            Assert.IsTrue(derivedModel.Parameters[0].Equals("label", "Label in front of the label field"));
        }

示例#10

        public void MemberWithSummaryAndDescription()
        {
            const string inputString  = @"This is our summary
Some more text";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(1, derivedModel.TextBlocks.Count);
            Assert.AreEqual("Some more text", derivedModel.TextBlocks[0].Text);
        }

示例#11

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MemberWithSummaryAndMultilineParam()
 {
     const string inputString = @"This is our summary
     @param label Label in
     front of the label field";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.AreEqual("This is our summary", derivedModel.Summary);
     Assert.AreEqual(1, derivedModel.Parameters.Count);
     Assert.IsTrue(derivedModel.Parameters[0].Equals("label", @"Label in
     front of the label field"));
     Assert.IsNull(derivedModel.ReturnDoc);
 }

示例#12

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MeaningfulBlockWithSignatures()
 {
     const string inputString = ParserToken.SignatureOpen+@"
     sig1
     sig2
     sig3
     sig4
     "+ParserToken.SignatureClose+@"
     Summary for all sigs";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.AreEqual("Summary for all sigs", derivedModel.Summary);
     Assert.AreEqual(0, derivedModel.TextBlocks.Count);
     Assert.AreEqual(0, derivedModel.Parameters.Count);
     Assert.AreEqual(4, derivedModel.SignatureList.Count);
 }

示例#13

        public void MemberWithSummaryAndOneExample()
        {
            const string inputString  = @"This is our summary
BEGIN EX
function foo()
{ int k=0;}
END EX";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(1, derivedModel.TextBlocks.Count);
            VerifyExample(derivedModel, 0, @"function foo()
{ int k=0;}
");
        }

示例#14

文件： MemDocReverseTests.cs 项目： ljmeijer/documentation

        public void ModifyReturnValue()
        {
            const string input = @"This is our summary
@return stupid stuff";
            var          model = new MeaningfulBlock(input);

            Assert.AreEqual("This is our summary", model.Summary);
            Assert.AreEqual("stupid stuff", model.ReturnDoc.Doc);

            model.ReturnDoc.Doc = "smart stuff";

            var actualOutput = model.ToString();

            Assert.AreEqual(@"This is our summary
@return smart stuff", actualOutput);
        }

示例#15

        public void MeaningfulBlockWithSignatures()
        {
            const string inputString  = ParserToken.SignatureOpen + @"
sig1
sig2
sig3
sig4
" + ParserToken.SignatureClose + @"
Summary for all sigs";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("Summary for all sigs", derivedModel.Summary);
            Assert.AreEqual(0, derivedModel.TextBlocks.Count);
            Assert.AreEqual(0, derivedModel.Parameters.Count);
            Assert.AreEqual(4, derivedModel.SignatureList.Count);
        }

示例#16

        public void MemberWithSummaryDescriptionAndNoCheckExample()
        {
            const string inputString  = @"This is our summary
hello hello
BEGIN EX NOCHECK
	function foo()
	{ int k=0;}
END EX";
            var          derivedModel = new MeaningfulBlock(inputString);

            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(2, derivedModel.TextBlocks.Count);

            VerifyExample(derivedModel, 1, @"	function foo()
	{ int k=0;}
");
            var example = derivedModel.TextBlocks[1] as ExampleBlock;

            Assert.IsTrue(example.IsNoCheck);
            Assert.IsFalse(example.IsConvertExample);
        }

示例#17

 void VerifyExample(MeaningfulBlock model, int index, string expectedText)
 {
     Assert.IsTrue(model.TextBlocks[index] is ExampleBlock);
     Assert.AreEqual(expectedText, model.TextBlocks[index].Text);
 }

示例#18

 void VerifyDescription(MeaningfulBlock model, int index, string expectedText)
 {
     Assert.IsFalse(model.TextBlocks[index] is ExampleBlock);
     Assert.AreEqual(expectedText, model.TextBlocks[index].Text);
 }

示例#19

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 void VerifyExample(MeaningfulBlock model, int index, string expectedText)
 {
     Assert.IsTrue(model.TextBlocks[index] is ExampleBlock);
     Assert.AreEqual(expectedText, model.TextBlocks[index].Text);
 }

示例#20

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 void VerifyDescription(MeaningfulBlock model, int index, string expectedText)
 {
     Assert.IsFalse(model.TextBlocks[index] is ExampleBlock);
     Assert.AreEqual(expectedText, model.TextBlocks[index].Text);
 }

示例#21

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

        public void NoCheckFollowedByConvertExample()
        {
            const string inputString =
                @"This is our summary
            BEGIN EX NOCHECK
             weight  name   layer   lower   upper
            END EX
             Blend weights blah blah
            CONVERTEXAMPLE
            BEGIN EX
            animation.weight = 0.5;
            END EX";
            var derivedModel = new MeaningfulBlock(inputString);
            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(3, derivedModel.TextBlocks.Count);

            var example1 = derivedModel.TextBlocks[0];

            Assert.IsTrue(example1 is ExampleBlock);
            Assert.IsTrue((example1 as ExampleBlock).IsNoCheck);
            VerifyExample(derivedModel, 0, @"	 weight  name   layer   lower   upper
            ");
            VerifyDescription(derivedModel, 1, @"	 Blend weights blah blah");

            var example2 = derivedModel.TextBlocks[2];
            Assert.IsTrue(example2 is ExampleBlock);
            Assert.IsFalse((example2 as ExampleBlock).IsNoCheck);
            VerifyExample(derivedModel, 2, @"		animation.weight = 0.5;
            ");
        }

示例#22

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

        public void MemberWithSummaryDescriptionAndNoCheckNextLine()
        {
            const string inputString = @"This is our summary
            hello hello
            BEGIN EX
            NOCHECK
            function foo()
            { int k=0;}
            END EX";
            var derivedModel = new MeaningfulBlock(inputString);
            Assert.AreEqual("This is our summary", derivedModel.Summary);
            Assert.AreEqual(2, derivedModel.TextBlocks.Count);

            VerifyExample(derivedModel, 1, @"	function foo()
            { int k=0;}
            ");
            var example = derivedModel.TextBlocks[1] as ExampleBlock;
            Assert.IsTrue(example.IsNoCheck);
            Assert.IsFalse(example.IsConvertExample);
        }

示例#23

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MemberWithSummaryAndReturn()
 {
     const string inputString = @"This is our summary
     @return stupid stuff";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.AreEqual("This is our summary", derivedModel.Summary);
     Assert.AreEqual(0, derivedModel.Parameters.Count);
     Assert.AreEqual("stupid stuff", derivedModel.ReturnDoc.Doc);
 }

示例#24

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void MemberWithSummaryAndOneExample()
 {
     const string inputString = @"This is our summary
     BEGIN EX
     function foo()
     { int k=0;}
     END EX";
     var derivedModel = new MeaningfulBlock(inputString);
     Assert.AreEqual("This is our summary", derivedModel.Summary);
     Assert.AreEqual(1, derivedModel.TextBlocks.Count);
     VerifyExample(derivedModel, 0, @"function foo()
     { int k=0;}
     ");
 }

示例#25

文件： MemDocReverseTests.cs 项目： paveltimofeev/documentation

        public void ModifyReturnValue()
        {
            const string input = @"This is our summary
            @return stupid stuff";
            var model = new MeaningfulBlock(input);

            Assert.AreEqual("This is our summary", model.Summary);
            Assert.AreEqual("stupid stuff", model.ReturnDoc.Doc);

            model.ReturnDoc.Doc = "smart stuff";

            var actualOutput = model.ToString();
            Assert.AreEqual(@"This is our summary
            @return smart stuff", actualOutput);
        }

示例#26

文件： MeaningfulBlockTests.cs 项目： paveltimofeev/documentation

 public void EmptyMember()
 {
     const string inputString = "";
     var expectedModel = new MeaningfulBlock(inputString);
     Assert.IsTrue(expectedModel.IsEmpty());
 }