What is the correct utf-8 encoding comment line for ruby?

Question

Possible Duplicate:
Ruby - UTF-8 file encoding

I'm using UTF-8 all the way and want to help the ruby interpreter to read my files. Therefore I put # encoding=utf-8 at the start of my ruby code like this:

#!/usr/bin/env ruby
# encoding=utf-8

But now and then, I see other variants: bundle gem NAME inserts # -*- encoding: utf-8 -*- (into NAME.gemspec). The gem magic_encoding uses this line, too.

What is the recommended way?

# encoding = utf-8
# encoding: utf-8
# -*- encoding: utf-8 -*-

score 6 · Accepted Answer · edited May 23 '17 at 11:58

6

Short answer:

# encoding: utf-8

This is a complete answer: Ruby - UTF-8 file encoding

edited May 23 '17 at 11:58

Community

1
1

answered Nov 07 '12 at 15:46

pdjota

3,053
2
22
33

Thanks. Because of the given link, I marked this as answer. – Johannes Nov 07 '12 at 16:04

score 3 · Answer 2 · answered Nov 07 '12 at 15:45

3

It looks like a fairly relaxed specification for what's acceptable. I've always used:

# encoding: UTF-8

Also acceptable is coding. I can't find a reference on the variants allowed, but so long as your file is being interpreted correctly it should be fine. Check the __ENCODING__ value to be sure it's being picked up.

answered Nov 07 '12 at 15:45

tadman

200,744
21
223
248

Thanks. I tried all variants - and all work. – Johannes Nov 07 '12 at 16:04

score 3 · Answer 3 · edited May 23 '17 at 11:58

3

Python behaves the same way, and the answer to this Python question suggests there is no real recommendation, just choose what works for your editor: for Emacs, use the # -*- encoding: utf-8 -*-; for VIM use # vim:fileencoding=<encoding-name>.

edited May 23 '17 at 11:58

Community

1
1

answered Nov 07 '12 at 16:15

steenslag

76,334
16
131
165

It's a good advice to stick to your editor's modelines. Thanks! – Johannes Nov 07 '12 at 21:36

What is the correct utf-8 encoding comment line for ruby?

3 Answers3