How do you typeset code elements in normal text? *

Question

What is the best way to typeset a function with arguments for readibility, brevity, and accuracy? I tend to put empty parentheses after the function name like func(), even if there are actually arguments for the function. I have trouble including the arguments and still feeling like the paragraph is readable.

Any thoughts on best practices for this?

Answer

I usually take that approach, but if I feel like it's going to cause confusion, I'll use ellipses like: myFunction(...)

I guess if I were good, I would use those any time I was omitting parameters from a function in text.

< br > via < a class="StackLink" href=" http://stackoverflow.com/questions/3802/" >How do you typeset code elements in normal text?< /a>
Share on Google Plus

About Cinema Guy

This is a short description in the author block about the author. You edit it by entering text in the "Biographical Info" field in the user admin panel.
    Blogger Comment
    Facebook Comment

0 comments:

Post a Comment