Sono stati definiti "implementatori", ma a me sembra strano.
/// <summary>
/// Implementers should implement this. Derp
/// </summary>
protected abstract void InternalExecute();
Un punto di chiarimento, mi interessa sapere come chiamare le persone che creano le classi figlio, non le classi figlio stesse.
"Ehi, tu lì" non "quella cosa lì".
La documentazione della classe MSDN usa spesso "tu" per riferirsi agli sviluppatori.
When you inherit from WebRequest, you must override the following members...
You do not typically inherit from ButtonBase. To create your own button class, inherit from the Button, CheckBox, or RadioButton class....
Puoi anche semplicemente indicare quali sono i requisiti per le classi discendenti. È implicito che gli sviluppatori siano il tuo pubblico.
Classes that inherit IDbConnection must implement all inherited members, and typically define additional members to add provider-specific functionality.
Nel tuo esempio, invece di "Implementatori dovrebbero implementare questo", scrivi "Le classi discendenti devono eseguire l'override di InternalExecute per ..." o "Nelle classi discendenti, devi eseguire l'override di InternalExecute per ...".
Di solito dico children , child classes o inheritors .
Non è così importante; le persone capiranno comunque cosa intendi per Implementers .
subclasses o classes that extend ThisInterface o classes that implement InternalExecute
Non dovresti menzionare le persone che codificano nel doc, ma come la classe base dovrebbe essere estesa, quindi potresti chiamarle "implementazioni"
es
This base class defines the basic structure of the blah blah blah. Implementations should do XYZ to make it work....
O
Implementations of this class should also consider...
In genere dico child class . Quando parlo di ereditarietà, implementers mi confonderebbe un po 'perché mi fa pensare che la classe stia implementando un'interfaccia, che è diversa dall'eredità di classe.
Se dovessi scrivere documentazione parlando direttamente a una persona che scrive codice che estende la mia classe base, li chiamerei uno sviluppatore , utente finale o dei consumatori .
Detto questo, penso che sia generalmente una cattiva idea fare riferimento alle persone che usano il tuo codice nei commenti. I commenti dovrebbero indicare che cosa fa il codice, non quello che dovrebbe fare lo sviluppatore che lo usa.
Voglio offrire un'idea pronta per l'uso: eliminiamo del tutto questo commento e quindi non abbiamo alcun problema su come esprimerlo .
La parola chiave abstract dice già tutto: una delle classi derivate deve implementare il metodo. Se questo è l'intento che vuoi comunicare agli implementatori di quelle classi derivate, allora stai già utilizzando questo particolare elemento del linguaggio in modo appropriato.
Leggi altre domande sui tag documentation terminology