https://github.com/khellang/jetbrains.annotations.dnx

https://github.com/khellang/jetbrains.annotations.dnx

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/khellang/jetbrains.annotations.dnx
• Owner: khellang
• License: mit
• Created: 2015-08-13T15:46:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-10T15:04:39.000Z (over 9 years ago)
• Last Synced: 2023-04-10T13:07:05.421Z (almost 2 years ago)
• Language: C#
• Size: 148 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JetBrains.Annotations.Dnx

Given the following class:

```csharp

namespace JetBrains.Annotations.Dnx

{

    [PublicAPI]

    [BaseTypeRequired(typeof(string))]

    public class TestClass : Attribute

    {

        [NotNull]

        private readonly string _readOnlyField, _otherField;

        public TestClass([NotNull] string value)

        {

        }

        [CanBeNull]

        public string Value { get; [NotNull] set; }

        [StringFormatMethod("format")]

        [ContractAnnotation("values:null => halt")]

        public void SomeMethod([NotNull, ItemNotNull, NoEnumeration] IEnumerable values, [CanBeNull] string format)

        {

        }

        public void GenericMethod([NotNull] [NoEnumeration] IEnumerable values)

        {

            

        }

    }

}

```

The following is produced in `./bin/{configuration}` at build-time:

```xml

  

    

    

      typeof(string)

    

  

  

    

  

  

    

  

  

    

      

    

  

  

    

  

  

    

  

  

    

      format

    

    

      values:null => halt

    

    

      

      

      

    

    

      

    

  

  

    

      

      

    

  

```

It's not 100% yet, but it's getting there :grin: