FaustVX.PrimaryParameter.SG 0.3.1

Primary Parameter

Description

Using a Field or Property attributes on parameters.

Automaticaly generate private readonly fields or private property.

Forbid the use of primary constructor's parameters.

Usage

partial class C([Field(Name = "_a"), Field, [Property(WithInit = true)]]int i) // type must be partial, but can be class / struct
{
	// private readonly int _a = i; // generated field
	// private readonly int _i = i; // generated field
	// private int { get; init; } = i; // generated Property
    public void M0()
    {
        i++;                    // error on usage of i
        Console.WriteLine(i);   // error on usage of i
    }
    public void M1()
    {
        var i = 0;
        i++;                    // don't error on usage of locals
        Console.WriteLine(_i);  // automaticaly created readonly field
        Console.WriteLine(_a);	// automaticaly created readonly field based on Name property
        Console.WriteLine(I);  // automaticaly created readonly property
    }
}

To eneble the feaure, type [Field] or [Property] before the primary parameter you want.

You can type as many attributes as you want on a single parameter.

Attribute Properties

<table> <tr> <th>Attributes</th> <th>Property</th> <th>Comments</th> <th>Default value</th> </tr> <tr> <td><code>Field</code></td> <td><code>Name</code></td> <td>property to modify the generated field name</td> <td><code>_i</code> (for a parameter named <code>i</code>)</td> </tr> <tr> <td rowspan="3"><code>Property</code></td> <td><code>Name</code></td> <td>property to modify the generated property name</td> <td><code>I</code> (for a parameter named <code>i</code>)</td> </tr> <tr> <td><code>WithInit</code></td> <td>to generate the <code>init</code> accessor along the <code>get</code></td> <td><code>false</code></td> </tr> <tr> <td><code>Scope</code></td> <td>to change the scope of the generated property</td> <td><code>private</code></td> </tr> </table>

Versions