সি # এর জন্য মন্তব্য উত্তরাধিকার (আসলে কোনও ভাষা)

Question 1

ধরুন আমার এই ইন্টারফেসটি আছে

public interface IFoo
{
    ///<summary>
    /// Foo method
    ///</summary>
    void Foo();

    ///<summary>
    /// Bar method
    ///</summary>
    void Bar();

    ///<summary>
    /// Situation normal
    ///</summary>
    void Snafu();
}

এবং এই ক্লাস

public class Foo : IFoo
{
    public void Foo() { ... }
    public void Bar() { ... }
    public void Snafu() { ... }
}

কোনও উপায় আছে, বা এমন কোনও সরঞ্জাম রয়েছে যা আমাকে স্বয়ংক্রিয়ভাবে প্রতিটি সদস্যের মন্তব্যগুলিকে বেস ক্লাস বা ইন্টারফেসে রাখতে দেয়?

কারণ আমি প্রতিটি উত্পন্ন উপ-শ্রেণীর জন্য একই মন্তব্যগুলি পুনরায় লেখার ঘৃণা করি!

Question 2

ঘোস্টডক ঠিক তা করে। উত্তরাধিকার সূত্রে প্রাপ্ত নয় এমন পদ্ধতিগুলির জন্য, এটি নামটি থেকে একটি বিবরণ তৈরি করার চেষ্টা করে।

FlingThing() হয়ে যায় "Flings the Thing"

Question 3

আপনি সর্বদা <inheritdoc />ট্যাগটি ব্যবহার করতে পারেন :

public class Foo : IFoo
{
    /// <inheritdoc />
    public void Foo() { ... }
    /// <inheritdoc />
    public void Bar() { ... }
    /// <inheritdoc />
    public void Snafu() { ... }
}

crefবৈশিষ্ট্যটি ব্যবহার করে , আপনি এমনকি সম্পূর্ণ ভিন্ন শ্রেণি বা নেমস্পেসে সম্পূর্ণ ভিন্ন সদস্যকে উল্লেখ করতে পারেন!

public class Foo
{
    /// <inheritdoc cref="System.String.IndexOf" />
    public void Bar() { ... } // this method will now have the documentation of System.String.IndexOf
}

Question 4

/// <inheritdoc/>উত্তরাধিকার চাইলে ব্যবহার করুন । ঘোস্টডক বা এ জাতীয় কিছু এড়িয়ে চলুন।

আমি সম্মত হই যে এটি বিরক্তিকর যে মন্তব্যগুলি উত্তরাধিকার সূত্রে প্রাপ্ত হয় না। কারও হাতে সময় থাকলে (আমি ইচ্ছা করতাম) তৈরি করা মোটামুটি সহজ অ্যাড-ইন হবে।

এটি বলেছে যে, আমাদের কোড বেসে আমরা কেবলমাত্র ইন্টারফেসে এক্সএমএল মন্তব্য করি এবং শ্রেণিতে অতিরিক্ত বাস্তবায়ন মন্তব্য যুক্ত করি। এটি আমাদের জন্য কাজ করে কারণ আমাদের ক্লাসগুলি ব্যক্তিগত / অভ্যন্তরীণ এবং কেবলমাত্র ইন্টারফেসটি সর্বজনীন। ইন্টারফেসের মাধ্যমে যে কোনও সময় আমরা বস্তুগুলি ব্যবহার করি আমাদের কাছে পূর্ণ মন্তব্যে ইন্টেলিজেন্সে প্রদর্শিত হয়।

ঘোস্টডক ভাল শুরু এবং মন্তব্যগুলি লেখার প্রক্রিয়াটিকে আরও সহজ করে তুলেছে। বিশেষত মন্তব্যগুলি আপ টু ডেট রাখার জন্য দরকারী যখন আপনি প্যারামিটারগুলি যুক্ত / সরান, ঘোস্টডক পুনরায় চালিত করুন এবং এটি বিবরণটি আপডেট করবে।

Question 5

জাভাতে এটি আছে এবং আমি এটি সর্বদা ব্যবহার করি। শুধু কর:

/**
 * {@inheritDoc}
 */

এবং জাভাডোক সরঞ্জামটি এটিকে চিত্রিত করে।

সি # এর সমান চিহ্ন রয়েছে:

<inheritDoc/>

আপনি এখানে আরও পড়তে পারেন:

http://www.ewoodruff.us/shfbdocs/html/79897974-ffc9-4b84-91a5-e50c66a0221d.htm

Question 6

আমি সরাসরি ব্যবহার করতে বলব

/// <inheritdoc cref="YourClass.YourMethod"/>  --> For methods inheritance

এবং

/// <inheritdoc cref="YourClass"/>  --> For directly class inheritance

আপনাকে এই মন্তব্যগুলি আপনার শ্রেণী / পদ্ধতির ঠিক আগের লাইনে রাখতে হবে

আপনি যেমন নথিবদ্ধ করেছেন এমন একটি ইন্টারফেস থেকে উদাহরণস্বরূপ আপনার মন্তব্যগুলির তথ্য পাবেন:

    /// <summary>
    /// This method is awesome!
    /// </summary>
    /// <param name="awesomeParam">The awesome parameter of the month!.</param>
    /// <returns>A <see cref="AwesomeObject"/> that is also awesome...</returns>
    AwesomeObject CreateAwesome(WhateverObject awesomeParam);

Question 7

রিশার্পারের কাছে বেস ক্লাস বা ইন্টারফেস থেকে মন্তব্যগুলি অনুলিপি করার বিকল্প রয়েছে।

Question 8

আর একটি উপায় হল <see />এক্সএমএল ডকুমেন্টেশন ট্যাগ ব্যবহার করা । এটি কিছু অতিরিক্ত প্রচেষ্টা কিন্তু বাক্সের বাইরে কাজ করে ...

এখানে কিছু উদাহরন:

/// <summary>
/// Implementation of <see cref="IFoo"/>.
/// </summary>
public class Foo : IFoo
{
    /// <summary>
    /// See <see cref="IFoo"/>.
    /// </summary>
    public void Foo() { ... }

    /// <summary>
    /// See <see cref="IFoo.Bar"/>
    /// </summary>
    public void Bar() { ... }

    /// <summary>
    /// This implementation of <see cref="IFoo.Snafu"/> uses the a caching algorithm for performance optimization.
    /// </summary>
    public void Snafu() { ... }
}

হালনাগাদ:

আমি এখন ব্যবহার করতে পছন্দ করি /// <inheritdoc/>যা এখন রিসার্পার দ্বারা সমর্থিত।

Question 9

আমি এক্সএমএল ডকুমেন্টেশন ফাইলগুলিতে <inheritdoc/>ট্যাগ প্রতিস্থাপনের জন্য সমর্থন যোগ করার জন্য এক্সএমএল ডকুমেন্টেশন ফাইলগুলি পোস্ট-প্রক্রিয়া করার জন্য একটি সরঞ্জাম তৈরি শেষ করেছি । Www.inheritdoc.io এ উপলব্ধ (বিনামূল্যে সংস্করণ উপলব্ধ)।

Question 10

ঠিক আছে, এক ধরণের দেশীয় সমাধান রয়েছে, আমি। নেট কোর ২.২ খুঁজে পেয়েছি

<include>ট্যাগটি ব্যবহার করার জন্য ধারণা ।

আপনি <GenerateDocumentationFile>true</GenerateDocumentationFile>আপনার .csprojফাইল যুক্ত করতে পারেন ।

আপনার একটি ইন্টারফেস থাকতে পারে:

namespace YourNamespace
{
    /// <summary>
    /// Represents interface for a type.
    /// </summary>
    public interface IType
    {
        /// <summary>
        /// Executes an action in read access mode.
        /// </summary>
        void ExecuteAction();
    }
}

এবং এটি থেকে উত্তরাধিকারসূত্রে প্রাপ্ত কিছু:

using System;

namespace YourNamespace
{
    /// <summary>
    /// A type inherited from <see cref="IType"/> interface.
    /// </summary>
    public class InheritedType : IType
    {
        /// <include file='bin\Release\netstandard2.0\YourNamespace.xml' path='doc/members/member[@name="M:YourNamespace.IType.ExecuteAction()"]/*'/>
        public void ExecuteAction() => Console.WriteLine("Action is executed.");
    }
}

ঠিক আছে, এটি কিছুটা ভীতিজনক তবে এটি প্রত্যাশিত উপাদানগুলিকে যুক্ত করে YourNamespace.xml।

আপনি যদি Debugকনফিগারেশনটি তৈরি করেন তবে এর বৈশিষ্ট্যের Releaseজন্য Debugআপনি অদলবদল করতে পারেনfileinclude ট্যাগ।

একটি সঠিক খুঁজতে member's nameখুলুন উত্পন্ন রেফারেন্স Documentation.xmlফাইল।

আমি আরও ধরে নিয়েছি যে এই পদ্ধতির জন্য কমপক্ষে দুবার (প্রথমবারের মতো এক্সএমএল ফাইল তৈরির জন্য, এবং দ্বিতীয় বার এটির থেকে উপাদানগুলি অনুলিপি করার জন্য) নির্মাণের জন্য একটি প্রকল্প বা সমাধানের প্রয়োজন।

উজ্জ্বল দিকটি হ'ল ভিজ্যুয়াল স্টুডিও অনুলিপি করা উপাদানগুলিকে বৈধতা দেয়, সুতরাং ডকুমেন্টেশন এবং কোডটি ইন্টারফেস / বেস শ্রেণি ইত্যাদির সাথে সমন্বয় করা খুব সহজ example

আমার প্রকল্পে, আমি উভয় <inheritdoc/>(ডকুএফএক্সের জন্য) এবং <include/>( নিউগেট প্যাকেজ প্রকাশের জন্য এবং ভিজুয়াল স্টুডিওতে বৈধতার জন্য) শেষ করেছি:

        /// <inheritdoc />
        /// <include file='bin\Release\netstandard2.0\Platform.Threading.xml' path='doc/members/member[@name="M:Platform.Threading.Synchronization.ISynchronization.ExecuteReadOperation(System.Action)"]/*'/>
        public void ExecuteReadOperation(Action action) => action();