Block Comments

MSDN Blog Postings » Block Comments

MSDN Blog Postings » Block Comments — Sun, 20 Jan 2008 03:00:23 GMT

PingBack from http://msdnrss.thecoderblogs.com/2008/01/19/block-comments/

re: Block Comments

Anonymous — Sun, 20 Jan 2008 18:41:44 GMT

Looks like the page link to connect leads to a Page not found or maybe it's not up yet.

"The content that you requested cannot be found or you do not have permission to view it. "

re: Block Comments

Sean McNeill — Sun, 20 Jan 2008 19:52:37 GMT

the link to the connect database does not work.

I think this debate is already solved by using Here-string, http://www.microsoft.com/technet/scriptcenter/resources/pstips/jun07/pstip0629.mspx

I use these on all my scripts at the beginning to document my script but I think here-string could also be used for commenting out large blocks of code

re: Block Comments

PowerShellTeam — Sun, 20 Jan 2008 20:03:05 GMT

Hmmm, the link works for me so that means that either you need to already have to be registered with CONNECT to use it or you have to be me to use it. :-(

You can navigate to the issue by signing into connect and searching FEEDBACK for:

CTP: Missing: Real uncomment a block

RE: Here Strings. THe issue with HERE strings is that they only work for content that is PROPER PowerShell syntax (i.e. PowerShell script). It does not work for arbitrary text.

Jeffrey Snover [MSFT]

Windows Management Partner Architect

Visit the Windows PowerShell Team blog at: http://blogs.msdn.com/PowerShell

Visit the Windows PowerShell ScriptCenter at: http://www.microsoft.com/technet/scriptcenter/hubs/msh.mspx

re: Block Comments

Shay Levi — Sun, 20 Jan 2008 20:11:31 GMT

FYI, I voted on it yesterday without a problem.

-----

Shay Levi

$cript Fanatic

http://scriptolog.blogspot.com

re: Block Comments

Sean Kearney — Sun, 20 Jan 2008 21:46:31 GMT

Well I'll admit to being (other than writing silly songs) a VERY new Powershell "newb".

As far as comments go here is my take.

If you FULLY understand the syntax, the "Block comment /* */ like in C makes it a LOT more readable.

If you are very new a simple # like used in Batch Files, Basic etc etc etc make's it easier to go through and understand what ISN'T code.

That's all. I'll leave it to the experts on a good old fashioned "Rumble"... :)

Cheers

Sean

"Highway to PowersHell"

Sometime soon to be an Mp3. Guard your ears.

re: Block Comments

Sean Kearney — Sun, 20 Jan 2008 21:50:34 GMT

Now for an "unfunny" comment / question.

What is a decent book to pickup to get you into the "Basics" of Powershell but is also a good overall deeper manual if needed?

Basically Powershell for Dummies :O

Sean

re: Block Comments

Steve Seguis — Mon, 21 Jan 2008 08:03:44 GMT

Block comments are the best. Please oh please include them in PS 2.0. It will help promote the concept of actually commenting your scripts (what a novel idea) since it's not as tedeious for those of us who still use notepad :)

For Sean: I'm working on Windows PowerShell 2.0 for Dummies for Wiley Press at the moment if that counts ;)

Steve Seguis

[Former MVP Admin Frameworks ]

re: Block Comments

Trevor Sullivan — Mon, 21 Jan 2008 17:19:40 GMT

Please support block quotes! One of my peeves about writing & debugging VBscripts is the inability to mass-comment lines of code.

I'll insert a comment/vote on Microsoft Connect as well.

re: Block Comments

Orrin — Mon, 21 Jan 2008 17:52:56 GMT

I've been using this for block comments in Powershell:

COMMENT GOES HERE

'@ > $null

KISS

Sridhar Ratnakumar — Mon, 21 Jan 2008 19:59:12 GMT

Go with multiline # comments. /* .. */ comments mixed with # one-line comments will look ugly.

In fact, C programmers sometimes comment like the following for good reasons:

* Now

* is

* the

* time

* to

* use

* PowerShell

That certainly looks better. For example, http://git.kernel.org/?p=git/git.git;a=blob;f=alloc.c;hb=HEAD

re: Block Comments

Sean Kearney — Tue, 22 Jan 2008 03:36:17 GMT

You know what? You're right. It takes me very little time to get used to normal code and looking at it twice, the block comments are a lot more readable.

re: Block Comments

Mike Schinkel — Wed, 23 Jan 2008 04:41:55 GMT

Jeffrey: "If you need help knowing what to think, let me know and I'll tell you. :-)"

Sounds like you could have a promising career in talk radio... '-)

Anyway, YES, provide multi-line comments. And MAKE THEM NESTABLE.

re: Block Comments

JaredPar — Wed, 23 Jan 2008 20:42:59 GMT

I kind of like having a # on every line. Yeah it looks hacky but it feels right for a scripting language.

re: Block Comments

jw — Thu, 24 Jan 2008 00:21:38 GMT

I've tried searching from Connect as the first comment suggested but I cannot find this. I am a member of Connect (had to deal with DST last year).

re: Block Comments

Sean — Thu, 24 Jan 2008 18:51:25 GMT

I would like to see support for block comments as well as single line comments. If you support both you end up making everyone happy, even those that like Sridhar who use both at the same time. I think it is pointless to use /* */ for a single line but the guy who introduced me to programming would use that for a single comment line in his C/C++ code. Why just have one way?

re: Block Comments

LeoTohill — Wed, 30 Jan 2008 17:45:07 GMT

Yes, there should be an language feature for block comments. I like #@...@# in the style of here strings. Like here strings, these tokens should be recognized only when alone on a line, thus avoiding accidental comments.

re: Block Comments

Alex Hokhlov — Tue, 26 Feb 2008 13:17:27 GMT

Block comments come in handy when I want to play with code in the MIDDLE of a line. Consider this: /* 0.5 * */ func($var1 /* 42 + args[0] */, bar($x) /* TODO: try $y */). Granted, one could break this piece into several lines and use # end comments, but that would look somewhat awkward and spacy. Beyond all good-style reasoning, I still believe the "one statement/one line" format is more natural, compact and easy to read.

re: Block Comments

dtginc — Wed, 07 May 2008 20:09:02 GMT

Couldn't follow the link. Here's my vote, though - PLEASE add block comments. The /*...*/ is a good format. Better yet, to keep with the # symbol, you could always use /#...#/.

Thanks!

re: Block Comments

karlsnooks — Fri, 28 Nov 2008 20:35:36 GMT

Was this ever resolved?

I definitely vote for block comments and not an indirect solution such as @'...'@ > $null or @" ..."@ approach.

karl

re: Block Comments

PowerShellTeam — Fri, 28 Nov 2008 23:32:30 GMT

Yes - V2 will have block comments.

anything you want

...

jps

re: Block Comments

karl snooks — Sat, 29 Nov 2008 04:12:06 GMT

Many thanks for speedy reply and am glad to see that we'll have block comments soon. will they be available on version 3?

re: Block Comments

PowerShellTeam — Sat, 29 Nov 2008 19:14:30 GMT

They will be available in CTP3 which we expect will be available sometime in Dec.

jps