Comments for classes/structures and members

Almost for every member and every type i use header, with comments
sometimes.

//(*****************************************************************)
// Comments.
public interface SimpleCollectionReaderInterface
{
//(===============================================================)
// Comments.
/// {Valid != null.}]]>
bool Contains(object item);

...
}

And huge of refactoring is useless for me.

Try to copy/move, for example, this interface, you will not see interface
header
in copy, and interface comments too.

Try to move member up/down, you will see mess with members headers and
comments.

I think this is important to fix, and it's realy easy to fix.

Don't tell me that all comets must be replaced with Xml documentation,
for very private members simple comments is all what we need, complexity
must be reasonable.




10 comments
Comment actions Permalink

You can comment your members with simple "///" comment. The XML tags are not
necessary.

--
Eugene Pasynkov
Developer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"
"Vladimir" <none@none.none> wrote in message
news:e485pu$oqi$1@is.intellij.net...

Almost for every member and every type i use header, with comments
sometimes.

>

//(*****************************************************************)
// Comments.
public interface SimpleCollectionReaderInterface
{
//(===============================================================)
// Comments.
/// <exception cref="ArgumentIsNullException">{Valid <paramref
name="item"/> != null.}</exception>
bool Contains(object item);

>

...
}

>

And huge of refactoring is useless for me.

>

Try to copy/move, for example, this interface, you will not see interface
header
in copy, and interface comments too.

>

Try to move member up/down, you will see mess with members headers and
comments.

>

I think this is important to fix, and it's realy easy to fix.

>

Don't tell me that all comets must be replaced with Xml documentation,
for very private members simple comments is all what we need, complexity
must be reasonable.

>
>
>



0
Comment actions Permalink

You can comment your members with simple "///" comment. The XML tags are
not necessary.


I will not do it, it's ridicule.

I want to see it in green.


0
Comment actions Permalink

They are green except for the starting "///" sequence. It's a question of
one extra '/':

/// Some green and useful comment.
private void Foo()
{
}

Using '///' comments for this case is recommended by C# language designers.

>> You can comment your members with simple "///" comment. The XML tags
>> are not necessary.
>>

I will not do it, it's ridicule.

I want to see it in green.

Thanks,
Andrey Simanovsky


0
Comment actions Permalink

Vladimir wrote:
>>You can comment your members with simple "///" comment. The XML tags are
>>not necessary.


I will not do it, it's ridicule.

I want to see it in green.


you can change the color to green in the Visual Studio options menu. The
name is 'XML Doc Comment'.

0
Comment actions Permalink

They are green except for the starting "///" sequence. It's a question of
one extra '/':


What is the problem to support "//" comments?


0
Comment actions Permalink

How would you distinguish comments attached to the class/method, and just
separator between groups?

--
Eugene Pasynkov
Developer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"
"Vladimir" <none@none.none> wrote in message
news:e4tnvn$7j9$1@is.intellij.net...
>> They are green except for the starting "///" sequence. It's a question of
>> one extra '/':
>

What is the problem to support "//" comments?



0
Comment actions Permalink

How would you distinguish comments attached to the class/method, and just
separator between groups?


All comment lines that closely attached to type or member (without blank
line after)
is part of this thing.

Look.

//(*****************************************************************)
// ...
// This comment is part of SimpleCollectionReaderInterface.
// ...
public interface SimpleCollectionReaderInterface
{
...
}

If you are commenting something between types or members you actualy doing
something like that.

public interface SimpleCollectionReaderInterface
{

public void SomeMethod1...

// ...
// This comment is not part of SomeMethod2.
// ...

public void SomeMethod2...
}


0
Comment actions Permalink

This consumption isn't evident.

Anyway, I do not see any reasons why not to follow MS guidelines to document
the code. The new programming language, new documenting design rules.

--
Eugene Pasynkov
Developer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"
"Vladimir" <none@none.none> wrote in message
news:e4vejt$1ar$1@is.intellij.net...
>> How would you distinguish comments attached to the class/method, and just
>> separator between groups?
>

All comment lines that closely attached to type or member (without blank
line after)
is part of this thing.

>

Look.

>

//(*****************************************************************)
// ...
// This comment is part of SimpleCollectionReaderInterface.
// ...
public interface SimpleCollectionReaderInterface
{
...
}

>

If you are commenting something between types or members you actualy doing
something like that.

>

public interface SimpleCollectionReaderInterface
{

>

public void SomeMethod1...

>

// ...
// This comment is not part of SomeMethod2.
// ...

>

public void SomeMethod2...
}

>



0
Comment actions Permalink

This consumption isn't evident.


Provide an option at least.

Anyway, I do not see any reasons why not to follow MS guidelines to
document the code. The new programming language, new documenting design
rules.


But i see.

I'm using comments (//) for types and members as prior information (it's
subject
to change) on stage of active develepment of types.

And of course i want to see // and /// in different collors.


0
Comment actions Permalink

1) We will not support attaching "//" comments to members
2) You can setup colors for comments as you wish in Visual Studio options
dialog

--
Eugene Pasynkov
Developer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"
"Vladimir" <none@none.none> wrote in message
news:e4vsr1$mdt$1@is.intellij.net...
>> This consumption isn't evident.
>

Provide an option at least.

>
>> Anyway, I do not see any reasons why not to follow MS guidelines to
>> document the code. The new programming language, new documenting design
>> rules.
>

But i see.

>

I'm using comments (//) for types and members as prior information (it's
subject
to change) on stage of active develepment of types.

>

And of course i want to see // and /// in different collors.

>



0

Please sign in to leave a comment.