Messages in this thread | | | Date | Tue, 13 Aug 2019 16:07:26 -0600 | From | Jonathan Corbet <> | Subject | Re: Best practice for embedded code samles? [Was: drm/drv: Use // for comments in example code] |
| |
On Sun, 11 Aug 2019 23:32:15 +0200 Sam Ravnborg <sam@ravnborg.org> wrote:
> I wonder if there is a better way to embed a code sample > than reverting to // style comments. > > As the kernel do not like // comments we should try to avoid them in > examples.
If you're embedding a code sample *into a code comment* then I suspect this is about as good as it gets. The alternative is to put it in as a plain literal text block. That would lose the syntax highlighting; I think that's an entirely bearable cost, but others seem to feel differently about it.
Thanks,
jon
| |