Як створити конструктор з класових полів за допомогою Visual Studio (та / або ReSharper)?


159

Я звик до багатьох Java IDE ( Eclipse , NetBeans та IntelliJ IDEA ), що дають вам команду генерувати конструктор за замовчуванням для класу на основі полів у класі.

Наприклад:

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;
    }
}

Наявність конструктором заповнення всіх полів об'єкта є такою поширеною задачею для більшості мов OOP, я припускаю, що є певний спосіб заощадити час на написанні цього кодового коду на C #. Я новачок у світі C #, тому мені цікаво, чи пропускаю я щось принципове у мові? Чи є якийсь варіант у Visual Studio, який очевидний?

Відповіді:


124

ReSharper пропонує інструмент Generate Constructor , де ви можете вибрати будь-яке поле / властивості, які ви хочете ініціалізувати. Для доступу до цього я використовую Alt+ Insгарячу клавішу.


Це відповідає мені на питання з точки зору "завершення роботи". Однак у VS2010 його немає прямої підтримки, правда?
Ілля

1
Як і Джаред згадує нижче, VS2010 додав інструмент "Створити з використання", але, наскільки я можу сказати, немає можливості створити конструктор на основі полів, які вже є в класі. Якщо ви спробуєте інстанціювати клас з підписом, який не відповідає жодному з існуючих, він запропонує створити цей конструктор для вас.
Джеймс Колпак

Ох вау, я знаю, це досить старе питання, але я тільки що це відкрив!
Бретт

49
Ви , ймовірно , слід згадати ReSharper це не безкоштовно .
b1nary.atr0phy

184

У Visual Studio 2015 Update3 у мене є ця функція.

Просто виділивши властивості, а потім натисніть Ctrl+, .а потім натисніть Створити конструктор .

Наприклад, якщо ви виділили два властивості, він запропонує вам створити конструктор з двома параметрами, а якщо ви вибрали три, він запропонує один із трьома параметрами тощо.

Він також працює з Visual Studio 2017.

Автоматичне створення візуалізації ярликів


3
Гей, це працювало для мене у спільноті Visual Studio 2015. Не впевнений, як це не дуже публічно відомо, але це приємно. Дякую. :)
The 0bserver

3
Це ідеально. Робота ця могла б врятувати, якби я прочитав її в той день, коли ви її опублікували ... xD
Тимо

3
Оскільки це варто, ця функція не з’являється, якщо ви використовуєте властивості C # 6, доступні лише для читання. (наприклад, public int Age { get; }) Їх потрібно мати в заданих сетерах, навіть якщо тимчасово, щоб мати можливість бути доступною. Перевірено у співтоваристві VS2015; не впевнений, чи це було зафіксовано у VS2017
Кріс Сінклер

1
@PouyaSamie: У C # 6.0 в конструкторі можуть бути призначені лише автоматичні властивості. Дивіться це для прикладу: github.com/dotnet/roslyn/wiki/…
Кріс Сінклер

5
Це ідеальне рішення! Я б відзначив це справжнім рішенням!
Вацлав Голуша

29

C # додав нову функцію у Visual Studio 2010 під назвою "генерувати з використання". Наміром є генерування стандартного коду із схеми використання. Однією з особливостей є створення конструктора на основі шаблону ініціалізації.

Ця функція доступна за допомогою розумного тегу, який з’явиться при виявленні шаблону.

Наприклад, скажімо, у мене такий клас

class MyType { 

}

І я пишу наступне у своїй заяві

var v1 = new MyType(42);

Конструктор, який приймає int, не існує, тому з'явиться розумний тег, і одним із варіантів буде "Створити заглушку конструктора". Вибір, який змінить код для MyTypeнаступного.

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

15

Ви можете написати макрос для цього - використовуйте аналізатор Visual Studio для отримання інформації про членів класу.

Я написав подібний макрос. (Я поділюсь кодом нижче). Макрос, який я написав, призначений для копіювання вперед усіх конструкторів базового класу, коли ви успадковуєте його (корисно для таких класів, як «Виняток», які мають багато перевантажень на ctor).

Ось мій макрос (знову ж таки, він не вирішує вашу проблему, але ви, ймовірно, можете змінити, щоб робити те, що вам потрібно)


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
Існує оператор відсутній: «Якщо searchParam.Type.AsFullName funcParam.Type.AsFullName Тоді» має бути «Якщо searchParam.Type.AsFullName = funcParam.Type.AsFullName Тоді»
LTR

1
@LTR Чудовий улов - за винятком випадків, якщо це "If searchParam.Type.AsFullName <> funcParam.Type.AsFullName". Я пропустив втечу на кутових дужках - вони з'явилися в редакторі, але не в перегляді. Дякую!
JMarsch

13

Станом на Visual Studio 2017, схоже, це вбудована функція. Натисніть Ctrl+, .поки ваш курсор знаходиться в тілі класу, і виберіть "Створити конструктор" зі спадного меню " Швидкі дії та відновлення" .


11

Ось макрос, який я використовую для цієї мети. Він створить конструктор із полів та властивостей, які мають приватний сетер.

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

Мені довелося розділити рядок: "If Not String.IsNullOrEmpty (parameterName) And Not VisitNames.ContainsKey (parameterName) Потім" на два рядки, щоб уникнути нульового посилання на виняток:
cedd

9

Можливо, ви могли б спробувати це: http://cometaddin.codeplex.com/


CodePlex вимкнено (але посилання наразі все ще є дещо дійсним із архівом, який можна завантажити). Але, можливо, спробуйте оновити посилання (якщо проект було перенесено в інше місце). І / або вживати заходів для запобігання катастрофи, якщо поточне посилання в майбутньому порушиться.
Пітер Мортенсен

5

Зробити це можна легко за допомогою ReSharper 8 або новішої версії. ctorf, ctorpІ ctorfpсниппет генерувати конструктор , які заповнюють все поля, властивість або поля і властивість класу.


4

Ось макрос Visual Studio JMarsh модифікований для створення конструктора на основі полів та властивостей у класі.

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 я знайшов розширення, яке робить саме це. Здається, він працює добре і має досить високу кількість завантажень. Тож якщо ви не можете чи не хочете використовувати ReSharper, можете замість цього встановити.

Ви також можете придбати його через NuGet .


-3

Я використовую такий фокус:

Я вибираю декларацію класу з членами даних і натискаю:

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

  • Перша команда копіює декларацію в буфер обміну,
  • Друга команда - це ярлик, який викликає ПРОГРАМУ
  • Остання команда замінює виділення текстом із буфера обміну.

ПРОГРАМА отримує декларацію з буфера обміну, знаходить назву класу, знаходить усіх членів та їх типи, створює конструктор і копіює все назад у буфер обміну.

Ми робимо це з першокурсниками на моїй практиці "Програмування-Я" (Карлов університет, Прага), і більшість студентів це робить до кінця години.

Якщо ви хочете побачити вихідний код, дайте мені знати.


1
Друга команда - це ярлик до перегляду класу, чи не так? Або ця порада не стосується Visual Studio 2010?
Джоел Пелтонен
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.