documentation - Ways to synchronize interface and implementation comments in C# -


What are the free methods to sync comments between the interface and its implementation? I am currently documenting both of them and do not want to keep them in sync manually.

Update:

Consider this code: 

  IFoo interface

When I create a class like this: 

  IFoo foo = new Foo (); Foo.DoThis (); // Comments are shown in intellisense

The comments are not shown here: 

  Foo foo = new Foo (); Foo.DoThis (); // Comments intellisense

is not shown in & lt; InheritDoc / & gt; The tag will generate a complete document in Sand Castle, but

thanks.

itemprop = "text">

You can use Microsoft Sandcastle (or NDoc) inheritcode Using tags, this can be done very easily. It is not officially supported by the specification, but custom tags are fully acceptable, and in fact Microsoft chose to copy it (and one or two other tags) to NDOK when they made the redcast. 

  /// & LT; Inheritdoc / & gt; /// & lt; Comment & gt; /// You can still specify all normal XML tags, and they are inherited according to ///. /// & lt; / Comment & gt; Public Null Method ImplementingInterfaceMethod (String Fu, Int Bar) {//}

The Sandcastle Help File Builder is a help page from GUI, which describes its usage thoroughly.

(Of course, this is not particularly "synchronization", as your question is mentioned, but it appears that whatever you are searching for.)

As a note, it seems to be a completely neutral idea for me, although I have noticed that some people think that you should always represent comments in derivative and implemented classes. (I have actually done this in documenting one of my libraries and I am not seeing any problem.) There is almost always no reason to be totally different for comments, so it is not just the heir and it is not Why is not the easy way?

Edit: Regarding your update, Sandcastle can also take care of it for you Sandcastle can use a modified version of the actual XML file for input, whose This means that you can distribute this modified version with your library DLL instead of one directly produced by Visual Studio, which means that with the comment in Intellisense, the documentation file (CHM, whatever Have ).


Comments

Post a Comment

Popular posts from this blog

python - Overriding the save method in Django ModelForm -

I'm having trouble overriding a ModelForm save method. I get this error I'm: Exception type: TypeErier Exception Value: Save () found an unexpected keyword argument 'committed' My intentions include a form 3 fields Submit several values ​​for, then create an object for each combination of those areas, and to save each object file models.py class collarsult type (models.Model): id = model. AutoField (db_column = 'icontact_result_code_type_id', primary_key = true) callResult = models.ForeignKey ( 'CallResult', db_column = 'icontact_result_code_id') campaign = models.ForeignKey ( 'campaign', db_column = 'icampaign_id') CALLTYPE = models.ForeignKey ( 'CALLTYPE', db_column = 'icall_type_id') agent = models.BooleanField (db_column = 'bagent', default = true) teamLeader = models.BooleanField (db_column = 'bTeamLeader', default = true) active = models.BooleanField (db_column = Django.form...
Read more

html - CSS autoheight, but fit content to height of div -

I have a div in which there are three children- div in the left and middle div: float: left while true: float: true because it is my layout Actually will spoil, I've used ClearFix Hack: .cf {zoom: 1; }. Cf: First,. Cf: {content: ""; Display: Table; }. Cf: After {clear: both; } It still works, but I want to be the right div an indicator. So it should fill 100% of the parent unit of height. How can I complete this? PS is the full code: & Lt; / Div & gt; & Lt; Div class = "mobile_content" & gt; & Lt; H5 & gt; {{Data.titel}} & lt; / H5> & Lt; Table & gt; & Lt; TR & gt; & Lt; Th & gt; Komponist: & lt; / Th & gt; & Lt; TD & gt; {{Data.komponist}} & lt; / TD & gt; & Lt; / TR & gt; & Lt; TR & gt; & Lt; Th & gt; Instrument: & lt; / Th & gt; & Lt; TD & gt; {{Data.instrumente}} & lt; / TD & gt; & Lt; / TR & gt;...
Read more

qt - How to prevent QAudioInput from automatically boosting the master volume to 100%? -

I have been trying to use Qt5 multimedia to record audio with QAudioInput, however, when I see If QAudioInput is started, it increases the master volume of my sound device to 100%. How can I prevent QAudioInput from changing the master volume? My current development platform is Linux with PalsAdio (with flat audio disabled). How can I use QAudioInput : QAudioDeviceInfo device_info = QAudioDeviceInfo :: defaultInputDevice (); QAudio format format; Format.setSampleRate (44100); Format.setChannelCount (1); Format.setSampleSize (16); Format.setCodec ("Audio / PCM"); Format.setSampleType (QAudioFormat :: SignedInt); Format.setByteOrder (QAudioFormat :: LittleEndian); Std :: cout & lt; & Lt; Device_info.deviceName (). ToUtf8 (). ConstData () & lt; & Lt; Std :: endl; QAudioInput * default_device = new QAudioInput (device_info, format); QIODevice * default_io_device = default_device-> Start (); a QAudioInput.setVolume () method is not you I ...
Read more