Visual Studio'yu (ve / veya ReSharper) kullanarak sınıf alanlarından nasıl bir yapıcı oluştururum?


159

Java IDE'lerin ( Eclipse , NetBeans ve IntelliJ IDEA ) birçoğuna alıştım ve sınıftaki alanlara dayalı bir sınıf için varsayılan bir kurucu oluşturmak için bir komut sağladım .

Örneğin:

public class Example
{
    public decimal MyNumber { get; set; }
    public string Description { get; set; }
    public int SomeInteger { get; set; }

    // ↓↓↓ This is what I want generated ↓↓↓
    public Example(decimal myNumber, string description, int someInteger)
    {
        MyNumber = myNumber;
        Description = description;
        SomeInteger = someInteger;
    }
}

Bir yapıcı tüm nesnelerin tüm alanları doldurmak sahip birçok OOP dillerinde böyle ortak bir görevdir, benim için bu kaynak plakası kodu yazmak C # zaman kazanmak için bir yol olduğunu varsayalım. C # dünyasında yeniyim, bu yüzden dil hakkında temel bir şey eksik olup olmadığını merak ediyorum? Visual Studio'da açık olan bazı seçenekler var mı?

Yanıtlar:


124

ReSharper, başlatılmasını istediğiniz herhangi bir alanı / özelliği seçebileceğiniz Oluşturucu Oluşturucu aracı sunar . ben kullanıyorumAltIns erişmek + kısayol tuşunu kullanıyorum.


Bu benim için soruyu "bitirmek" açısından cevaplıyor. Ancak, doğrudan VS2010'da destek yok, değil mi?
Elijah

1
Aşağıdaki Jared gibi, VS2010 bir "Kullanımdan üret" aracı ekledi, ancak anlayabildiğim kadarıyla, zaten sınıfta olan alanlara dayalı bir kurucu oluşturmanın yolu yok. Sınıfı mevcut olanlarla eşleşmeyen bir imzayla başlatmaya çalışırsanız, bu yapıcıyı sizin için oluşturmayı önerecektir.
James Kolpack

Vay canına, bunun oldukça eski bir soru olduğunu biliyorum ama sadece bunu keşfettim!
Brett

49
Muhtemelen ReSharper'ın ücretsiz olmadığını belirtmelisiniz .
b1nary.atr0phy

184

Visual Studio 2015 Update3'te bu özelliğe sahibim.

Sadece özellikleri vurgulayıp Ctrl+ .düğmesine basın ve ardından Oluşturucu Oluştur'a basın .

Örneğin, iki özelliği vurguladıysanız, iki parametreli bir kurucu oluşturmanızı önerir ve üçünü seçtiyseniz, üç parametreli bir tane önerir.

Visual Studio 2017 ile de çalışır.

Kısayol görselleştirmesini otomatik oluştur


3
Hey, bu benim için Visual Studio 2015 topluluğunda çalıştı. Emin değilim nasıl çok kamuya bilinen değil, ama bu güzel. Teşekkürler. :)
sunucu 23:17

3
Bu harika. Eğer yayınladığınız gün okursam bu kurtarmış olabilir ... xD
Timo

3
Değeri ne olursa olsun, C # 6 salt okunur özelliklerini kullanırsanız özellik açılmaz. (örn. public int Age { get; }) Seçeneğin kullanılabilmesi için geçici olarak da olsa ayarlayıcılarda belirtilmiş olmaları gerekir. VS2015 Topluluğu'nda test edilmiştir; VS2017'de düzeltilip düzeltilmediğinden emin değilim.
Chris Sinclair

1
@PouyaSamie: C # 6.0'da, salt okunur otomatik özellikler yapıcıda atanabilir. Bir örnek için buna bakın: github.com/dotnet/roslyn/wiki/…
Chris Sinclair

5
Bu mükemmel bir çözüm! Bunu gerçek çözüm olarak işaretlerdim!
Václav Holuša

29

C #, Visual Studio 2010'da kullanımdan oluşturma adı verilen yeni bir özellik ekledi. Amaç, bir kullanım modelinden standart kodu oluşturmaktır. Özelliklerden biri, bir başlatma modelini temel alan bir kurucu oluşturmaktır.

Özelliğe, desen algılandığında görünecek akıllı etiket üzerinden erişilebilir.

Örneğin, aşağıdaki sınıfa sahip olduğumu varsayalım

class MyType { 

}

Ve başvurumda aşağıdakileri yazıyorum

var v1 = new MyType(42);

Alan adında bir kurucu intmevcut olmadığından akıllı bir etiket görünecek ve seçeneklerden biri "Oluşturucu saplaması oluştur" olacaktır. Bunun seçilmesi için kod MyTypeaşağıdaki gibi değiştirilecektir.

class MyType {
    private int p;
    public MyType(int p) {
        // TODO: Complete member initialization
        this.p = p;
    }
}

15

Bunu yapmak için bir makro yazabilirsiniz - sınıfın üyeleri hakkında bilgi almak için Visual Studio'nun ayrıştırıcısını kullanırsınız.

Benzer bir makro yazdım. (Aşağıdaki kodu paylaşacağım). Yazdığım makro, miras aldığınızda bir temel sınıftaki tüm kurucuları ileriye doğru kopyalamak içindir (Ctor'da çok fazla aşırı yüklenme olan Exception gibi sınıflar için yararlıdır).

İşte benim makrom (yine, sorununuzu çözmez, ancak istediğinizi yapmak için muhtemelen değiştirebilirsiniz)


Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE100
Imports System.Diagnostics

Public Module ConstructorEditor
    Public Sub StubConstructors()
        'adds stubs for all of the constructors in the current class's base class
        Dim selection As TextSelection = DTE.ActiveDocument.Selection
        Dim classInfo As CodeClass2 = GetClassElement()

        If classInfo Is Nothing Then
            System.Windows.Forms.MessageBox.Show("No class was found surrounding the cursor.  Make sure that this file compiles and try again.", "Error")
            Return
        End If

        If classInfo.Bases.Count = 0 Then
            System.Windows.Forms.MessageBox.Show("No parent class was found for this class.  Make sure that this file, and any file containing parent classes compiles and try again")
            Return
        End If

        'setting up an undo context -- one ctrl+z undoes everything
        Dim closeUndoContext As Boolean = False
        If DTE.UndoContext.IsOpen = False Then
            closeUndoContext = True
            DTE.UndoContext.Open("StubConstructorsContext", False)
        End If

        Try
            Dim parentInfo As CodeClass2 = classInfo.Bases.Item(1)
            Dim childConstructors As System.Collections.Generic.List(Of CodeFunction2) = GetConstructors(classInfo)
            Dim parentConstructors As System.Collections.Generic.List(Of CodeFunction2) = GetConstructors(parentInfo)
            For Each constructor As CodeFunction2 In parentConstructors
                If Not MatchingSignatureExists(constructor, childConstructors) Then
                    ' we only want to create ctor stubs for ctors that are missing
                    ' note: a dictionary could be more efficient, but I doubt most classes will have more than 4 or 5 ctors...
                    StubConstructor(classInfo, constructor)
                End If
            Next
        Finally
            If closeUndoContext Then
                DTE.UndoContext.Close()
            End If
        End Try
    End Sub
    Private Function GetConstructors(ByVal classInfo As CodeClass2) As System.Collections.Generic.List(Of CodeFunction2)
        ' return a list of all of the constructors in the specified class
        Dim result As System.Collections.Generic.List(Of CodeFunction2) = New System.Collections.Generic.List(Of CodeFunction2)
        Dim func As CodeFunction2
        For Each member As CodeElement2 In classInfo.Members
            ' members collection has all class members.  filter out just the function members, and then of the functions, grab just the ctors
            func = TryCast(member, CodeFunction2)
            If func Is Nothing Then Continue For
            If func.FunctionKind = vsCMFunction.vsCMFunctionConstructor Then
                result.Add(func)
            End If
        Next
        Return result
    End Function
    Private Function MatchingSignatureExists(ByVal searchFunction As CodeFunction2, ByVal functions As System.Collections.Generic.List(Of CodeFunction2)) As Boolean
        ' given a function (searchFunction), searches a list of functions where the function signatures (not necessarily the names) match
        ' return null if no match is found, otherwise returns first match
        For Each func As CodeFunction In functions
            If func.Parameters.Count <> searchFunction.Parameters.Count Then Continue For
            Dim searchParam As CodeParameter2
            Dim funcParam As CodeParameter2
            Dim match As Boolean = True

            For count As Integer = 1 To searchFunction.Parameters.Count
                searchParam = searchFunction.Parameters.Item(count)
                funcParam = func.Parameters.Item(count)
                If searchParam.Type.AsFullName <> funcParam.Type.AsFullName Then
                    match = False
                    Exit For
                End If
            Next

            If match Then
                Return True
            End If
        Next
        ' no match found
        Return False
    End Function

    Private Sub StubConstructor(ByVal classInfo As CodeClass2, ByVal parentConstructor As CodeFunction2)
        ' adds a constructor to the current class, based upon the parentConstructor that is passed in

        ' highly inefficient hack to position the ctor where I want it (after the last ctor in the class, if there is another ctor
        ' note that passing zero as the position (put the ctor first) caused some problems when we were adding ctors to classes that already had ctors
        Dim position As Object
        Dim ctors As System.Collections.Generic.List(Of CodeFunction2) = GetConstructors(classInfo)

        If ctors.Count = 0 Then
            position = 0
        Else
            position = ctors.Item(ctors.Count - 1)
        End If

        ' if there are no other ctors, put this one at the top
        Dim ctor As CodeFunction2 = classInfo.AddFunction(classInfo.Name, vsCMFunction.vsCMFunctionConstructor, vsCMTypeRef.vsCMTypeRefVoid, position, parentConstructor.Access)

        Dim baseCall As String = ":base("
        Dim separator As String = ""
        For Each parameter As CodeParameter2 In parentConstructor.Parameters
            ctor.AddParameter(parameter.Name, parameter.Type, -1)
            baseCall += separator + parameter.Name
            separator = ", "
        Next
        baseCall += ")"

        ' and 1 sad hack -- appears to be no way to programmatically add the :base() calls without using direct string manipulation
        Dim startPoint As TextPoint = ctor.GetStartPoint()
        Dim endOfSignature As EditPoint = startPoint.CreateEditPoint()
        endOfSignature.EndOfLine()
        endOfSignature.Insert(baseCall)
        startPoint.CreateEditPoint().SmartFormat(endOfSignature)
    End Sub

    Private Function GetClassElement() As CodeClass2
        'returns a CodeClass2 element representing the class that the cursor is within, or null if there is no class
        Try
            Dim selection As TextSelection = DTE.ActiveDocument.Selection
            Dim fileCodeModel As FileCodeModel2 = DTE.ActiveDocument.ProjectItem.FileCodeModel
            Dim element As CodeElement2 = fileCodeModel.CodeElementFromPoint(selection.TopPoint, vsCMElement.vsCMElementClass)
            Return element
        Catch
            Return Nothing
        End Try
    End Function

End Module


1
Eksik bir operatör vardır: "searchParam.Type.AsFullName funcParam.Type.AsFullName Sonra ise" "searchParam.Type.AsFullName = funcParam.Type.AsFullName Eğer Sonra" olmalıdır
LTR

1
@LTR Büyük catch - "searchParam.Type.AsFullName <> funcParam.Type.AsFullName ise" olması gerekiyordu. Köşeli parantezlerin kaçışını kaçırdım - editörde göründüler, ancak görünümde değiller. Teşekkürler!
JMarsch

13

Visual Studio 2017 itibariyle, bu yerleşik bir özellik gibi görünüyor. Hit Ctrl+ .imleci sınıf vücutta olduğunu ve seçerken "Oluşturucu Oluştur" dan Hızlı Eylemler ve düzenlemeleri açılır.


11

İşte bu amaçla kullandığım bir makro. Özel ayarlayıcı içeren alanlardan ve özelliklerden bir kurucu oluşturur.

Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE90a
Imports EnvDTE100
Imports System.Diagnostics
Imports System.Collections.Generic

Public Module Temp

    Sub AddConstructorFromFields()
        DTE.UndoContext.Open("Add constructor from fields")

        Dim classElement As CodeClass, index As Integer
        GetClassAndInsertionIndex(classElement, index)

        Dim constructor As CodeFunction
        constructor = classElement.AddFunction(classElement.Name, vsCMFunction.vsCMFunctionConstructor, vsCMTypeRef.vsCMTypeRefVoid, index, vsCMAccess.vsCMAccessPublic)

        Dim visitedNames As New Dictionary(Of String, String)
        Dim element As CodeElement, parameterPosition As Integer, isFirst As Boolean = True
        For Each element In classElement.Children
            Dim fieldType As String
            Dim fieldName As String
            Dim parameterName As String

            Select Case element.Kind
                Case vsCMElement.vsCMElementVariable
                    Dim field As CodeVariable = CType(element, CodeVariable)
                    fieldType = field.Type.AsString
                    fieldName = field.Name
                    parameterName = field.Name.TrimStart("_".ToCharArray())

                Case vsCMElement.vsCMElementProperty
                    Dim field As CodeProperty = CType(element, CodeProperty)
                    If field.Setter.Access = vsCMAccess.vsCMAccessPrivate Then
                        fieldType = field.Type.AsString
                        fieldName = field.Name
                        parameterName = field.Name.Substring(0, 1).ToLower() + field.Name.Substring(1)
                    End If
            End Select

            If Not String.IsNullOrEmpty(parameterName) And Not visitedNames.ContainsKey(parameterName) Then
                visitedNames.Add(parameterName, parameterName)

                constructor.AddParameter(parameterName, fieldType, parameterPosition)

                Dim endPoint As EditPoint
                endPoint = constructor.EndPoint.CreateEditPoint()
                endPoint.LineUp()
                endPoint.EndOfLine()

                If Not isFirst Then
                    endPoint.Insert(Environment.NewLine)
                Else
                    isFirst = False
                End If

                endPoint.Insert(String.Format(MemberAssignmentFormat(constructor.Language), fieldName, parameterName))

                parameterPosition = parameterPosition + 1
            End If
        Next

        DTE.UndoContext.Close()

        Try
            ' This command fails sometimes '
            DTE.ExecuteCommand("Edit.FormatDocument")
        Catch ex As Exception
        End Try
    End Sub
    Private Sub GetClassAndInsertionIndex(ByRef classElement As CodeClass, ByRef index As Integer, Optional ByVal useStartIndex As Boolean = False)
        Dim selection As TextSelection
        selection = CType(DTE.ActiveDocument.Selection, TextSelection)

        classElement = CType(selection.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)

        Dim childElement As CodeElement
        index = 0
        For Each childElement In classElement.Children
            Dim childOffset As Integer
            childOffset = childElement.GetStartPoint(vsCMPart.vsCMPartWholeWithAttributes).AbsoluteCharOffset
            If selection.ActivePoint.AbsoluteCharOffset < childOffset Or useStartIndex Then
                Exit For
            End If
            index = index + 1
        Next
    End Sub
    Private ReadOnly Property MemberAssignmentFormat(ByVal language As String) As String
        Get
            Select Case language
                Case CodeModelLanguageConstants.vsCMLanguageCSharp
                    Return "this.{0} = {1};"

                Case CodeModelLanguageConstants.vsCMLanguageVB
                    Return "Me.{0} = {1}"

                Case Else
                    Return ""
            End Select
        End Get
    End Property
End Module

Satırı bölmek zorunda kaldım: "Eğer String.IsNullOrEmpty (parametreAdı) Ve ziyaret edilmemişNames.ContainsKey (parametreAdı) Sonra" boş bir referans istisnasını önlemek için iki satır içine:
cedd

9

Belki bunu deneyebilirsiniz: http://cometaddin.codeplex.com/


CodePlex kapatıldı (ancak bağlantı şu anda indirilebilir bir arşivle hala geçerli). Ancak belki de bağlantıyı güncellemeye çalışın (proje başka bir yere taşındıysa). Ve / veya mevcut bağlantı gelecekte bozulursa bir felaketi önlemek için adımlar atın.
Peter Mortensen

5

Bunu ReSharper 8 veya daha yenisiyle kolayca yapabilirsiniz. ctorf, ctorpVe ctorfpparçacıkları tüm alanları, özellikleri, veya alanları ve bir sınıfın özelliklerini doldurmak Kurucular üretir.


4

İşte JMarsh'ın Visual Studio makrosu, sınıftaki alanlara ve özelliklere dayalı bir kurucu oluşturacak şekilde değiştirildi.

Imports System
Imports EnvDTE
Imports EnvDTE80
Imports EnvDTE90
Imports EnvDTE100
Imports System.Diagnostics
Imports System.Collections.Generic

Public Module ConstructorEditor

    Public Sub AddConstructorFromFields()

        Dim classInfo As CodeClass2 = GetClassElement()
        If classInfo Is Nothing Then
            System.Windows.Forms.MessageBox.Show("No class was found surrounding the cursor.  Make sure that this file compiles and try again.", "Error")
            Return
        End If

        ' Setting up undo context. One Ctrl+Z undoes everything
        Dim closeUndoContext As Boolean = False
        If DTE.UndoContext.IsOpen = False Then
            closeUndoContext = True
            DTE.UndoContext.Open("AddConstructorFromFields", False)
        End If

        Try
            Dim dataMembers As List(Of DataMember) = GetDataMembers(classInfo)
            AddConstructor(classInfo, dataMembers)
        Finally
            If closeUndoContext Then
                DTE.UndoContext.Close()
            End If
        End Try

    End Sub

    Private Function GetClassElement() As CodeClass2
        ' Returns a CodeClass2 element representing the class that the cursor is within, or null if there is no class
        Try
            Dim selection As TextSelection = DTE.ActiveDocument.Selection
            Dim fileCodeModel As FileCodeModel2 = DTE.ActiveDocument.ProjectItem.FileCodeModel
            Dim element As CodeElement2 = fileCodeModel.CodeElementFromPoint(selection.TopPoint, vsCMElement.vsCMElementClass)
            Return element
        Catch
            Return Nothing
        End Try
    End Function

    Private Function GetDataMembers(ByVal classInfo As CodeClass2) As System.Collections.Generic.List(Of DataMember)

        Dim dataMembers As List(Of DataMember) = New List(Of DataMember)
        Dim prop As CodeProperty2
        Dim v As CodeVariable2

        For Each member As CodeElement2 In classInfo.Members

            prop = TryCast(member, CodeProperty2)
            If Not prop Is Nothing Then
                dataMembers.Add(DataMember.FromProperty(prop.Name, prop.Type))
            End If

            v = TryCast(member, CodeVariable2)
            If Not v Is Nothing Then
                If v.Name.StartsWith("_") And Not v.IsConstant Then
                    dataMembers.Add(DataMember.FromPrivateVariable(v.Name, v.Type))
                End If
            End If

        Next

        Return dataMembers

    End Function

    Private Sub AddConstructor(ByVal classInfo As CodeClass2, ByVal dataMembers As List(Of DataMember))

        ' Put constructor after the data members
        Dim position As Object = dataMembers.Count

        ' Add new constructor
        Dim ctor As CodeFunction2 = classInfo.AddFunction(classInfo.Name, vsCMFunction.vsCMFunctionConstructor, vsCMTypeRef.vsCMTypeRefVoid, position, vsCMAccess.vsCMAccessPublic)

        For Each dataMember As DataMember In dataMembers
            ctor.AddParameter(dataMember.NameLocal, dataMember.Type, -1)
        Next

        ' Assignments
        Dim startPoint As TextPoint = ctor.GetStartPoint(vsCMPart.vsCMPartBody)
        Dim point As EditPoint = startPoint.CreateEditPoint()
        For Each dataMember As DataMember In dataMembers
            point.Insert("            " + dataMember.Name + " = " + dataMember.NameLocal + ";" + Environment.NewLine)
        Next

    End Sub

    Class DataMember

        Public Name As String
        Public NameLocal As String
        Public Type As Object

        Private Sub New(ByVal name As String, ByVal nameLocal As String, ByVal type As Object)
            Me.Name = name
            Me.NameLocal = nameLocal
            Me.Type = type
        End Sub

        Shared Function FromProperty(ByVal name As String, ByVal type As Object)

            Dim nameLocal As String
            If Len(name) > 1 Then
                nameLocal = name.Substring(0, 1).ToLower + name.Substring(1)
            Else
                nameLocal = name.ToLower()
            End If

            Return New DataMember(name, nameLocal, type)

        End Function

        Shared Function FromPrivateVariable(ByVal name As String, ByVal type As Object)

            If Not name.StartsWith("_") Then
                Throw New ArgumentException("Expected private variable name to start with underscore.")
            End If

            Dim nameLocal As String = name.Substring(1)

            Return New DataMember(name, nameLocal, type)

        End Function

    End Class

End Module

2

Visual Studio 2015 için bir uzantı buldum . İyi çalışıyor gibi görünüyor ve oldukça yüksek bir indirme sayısına sahip. Yani ReSharper'ı kullanamıyorsanız veya kullanmak istemiyorsanız bunun yerine bunu yükleyebilirsiniz.

NuGet aracılığıyla da edinebilirsiniz .


-3

Aşağıdaki hileyi kullanıyorum:

Veri üyeleriyle birlikte sınıfın tanımını seçiyorum ve tuşuna basın:

Ctrl+ C, Shift+ Ctrl+ C, Ctrl+ V.

  • İlk komut bildirimi panoya kopyalar,
  • İkinci komut, PROGRAM'ı çağıran bir kısayoldur
  • Son komut, seçimin panodaki metne göre üzerine yazılır.

PROGRAM bildirimi panodan alır, sınıfın adını bulur, tüm üyeleri ve türlerini bulur, kurucu oluşturur ve hepsini panoya kopyalar.

Bunu "Programlama-I" uygulamamda (Charles Üniversitesi, Prag) birinci sınıf öğrencileriyle yapıyoruz ve öğrencilerin çoğu bunu saatin sonuna kadar yapıyor.

Kaynak kodunu görmek istiyorsanız bana bildirin.


1
İkinci komut sınıf görünümüne bir kısayoldur, değil mi? Yoksa bu ipucu Visual Studio 2010 ile ilgili değil mi?
Joel Peltonen
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.