How do I write comments in a SpecFlow Feature?

Question

I'd like to include some comments in a SpecFlow feature.

I get the the following error:

Custom tool error: Parsing error near '/*'

I've tried the following:

// comment
/* comment */
-- comment
' comment

How do I do this?

yes. and no. i don't have enough rep yet to answer my own question. i could only add comment with answer! :) — Kofi Sarfo, Jan 27 '12 at 13:25

score 84 · Accepted Answer · edited May 13 '20 at 10:26

84

As stated by sarfest above - its simply #-sign for comments.

There are no multiline comments but that's easily solved if you can do a vertical selection (hold down ALT-key and select in Visual Studio). Vertical select and the enter a #-sign.

Additional information: the line has to start with a #, and optionally any whitespace. This means you cannot combine comments with actual code on the same line.

edited May 13 '20 at 10:26

Good Night Nerd Pride

8,245
4
49
65

answered Jan 27 '12 at 15:38

Marcus Hammarberg

4,762
1
31
37

4

When testing using the feature language, my goal is to define a feature language that is - as far as possible - self descriptive. With that in mind, there should only be less need for additional comments. Don't get me wrong, I use comments in the feature files myself, however, if I find myself writing a multiline comment in the feature, I ask myself: "How can I improve my feature language in order to avoid such comments?" – realtime Sep 17 '14 at 06:10

score 8 · Answer 2 · answered Dec 08 '13 at 06:19

8

also, if you want to perform multiline comments in an easy way (on visual studio),

you can select the lines to be commented, and hit CTRL+K+C to comment, CTRL+K+U to Uncomment.

answered Dec 08 '13 at 06:19

Wasafa1

785
2
10
21

5

This does work in SpecFlow feature files now for anyone who comes across this question now. – zgirod Aug 04 '15 at 10:40
As of today this WORKS in SpecFlow feature files. The comment above is no longer true – Jérôme MEVEL Aug 05 '20 at 13:45

score 2 · Answer 3 · edited Jun 20 '20 at 09:12

2

thank you for the wonderful idea. I just need to press ALT and select the entire lines (just the little space which holds only one character space in each line) and then enter # which result from xyz abc to

'# xyz'

'# abc'

edited Jun 20 '20 at 09:12

Community

1
1

answered Jan 22 '16 at 15:03

confidential

21
1

score 0 · Answer 4 · answered Jul 19 '14 at 08:49

0

You can add comment lines to the feature files at any place starting the line with the # sign. Be careful however, as comments in the specification are often signs of wrongly specified acceptance criteria.

The comment lines are ignored by SpecFlow.

answered Jul 19 '14 at 08:49

Nirav Mehta

87
1
4

How do I write comments in a SpecFlow Feature?

4 Answers4

'# xyz'

'# abc'