top of page


Aaron Thomas
Aaron Thomas


C# provides a mechanism for programmers to document their code using a comment syntax that contains XML text. In source code files, comments having a certain form can be used to direct a tool to produce XML from those comments and the source code elements, which they precede. Comments using such syntax are called documentation comments. They must immediately precede a user-defined type (such as a class, delegate, or interface) or a member (such as a field, event, property, or method). The XML generation tool is called the documentation generator. (This generator could be, but need not be, the C# compiler itself.) The output produced by the documentation generator is called the documentation file. A documentation file is used as input to a documentation viewer; a tool intended to produce some sort of visual display of type information and its associated documentation.


For papers that include identifying, or potentially identifying, information, authors must download the Consent Form for Publication in a PLOS Journal, which the individual, parent, or guardian must sign once they have read the paper and been informed about the terms of PLOS open-access license. The signed consent form should not be submitted with the manuscript, but authors should securely file it in the individual's case notes and the methods section of the manuscript should explicitly state that consent authorization for publication is on file, using wording like:

As an alternative, you can download a transcript as a WebVTT file, edit it, then reupload it. First, download the transcript as a WebVTT file and open it in a text editor or caption or subtitle editor of your choice. Make your edits and save the file. Delete the existing transcript file from the video, then upload your edited WebVTT file in its place.

Save hours of time: skip the download and transfer files directly from any website into your MediaFire storage! Just paste in any link to a file and MediaFire will automatically upload it to your account.

Owners, Admins, and Editors on a sheet can add, version, or delete attachments. Anyone with access to the sheet can view and download attachments. You can send an attachment in an email to anyone with a valid email address. Some online storage services require people to have additional permission settings before they can access or edit the file.

Some files (for example, images) that were uploaded from a computer or mobile device can be viewed directly in Smartsheet. Others, you may need to download to your own device in order to view or edit them. Smartsheet supports attachments from various online storage services that may offer editing capabilities.

Only lists created in Leganto are published by default, including lists created using the NEW LIST button on the My Lists page or using the Create button on the Quick Start screen. Lists that are created by other means, including the Reading List Loader integration profile, the API, or using the Alma interface are not published automatically.

You can enable instructors to embed electronic or uploaded file citations directly in Leganto. The embedded citation appears in an iFrame below the link that students can select to view the citation in a new tab or download the citation. When you enable this feature, you allow instructors to turn on embedding for each citation (by default, embedding is turned off for all citations).

Annotations are stored as a separate layer on the file, visible only in Leganto and within the context of the reading list. They will not be added to printed or downloaded versions of the file, and private/public annotations are only copied when selecting Move item to the same list.

Please submit manuscripts electronically through the Manuscript Submission Portal in Microsoft Word (.docx) or LaTex (.tex) as a zip file with an accompanied Portable Document Format (.pdf) of the manuscript file.

Preferred formats for graphics files are TIFF and JPG, and preferred format for vector-based files is EPS. Graphics downloaded or saved from web pages are not acceptable for publication. Multipanel figures (i.e., figures with parts labeled a, b, c, d, etc.) should be assembled into one file. When possible, please place symbol legends below the figure instead of to the side.

You are encouraged to add links for API names (listed immediately above) using the @link tag. It is not necessary to add links for all API names in a doc comment. Because links call attention to themselves (by their color and underline in HTML, and by their length in source code doc comments), it can make the comments more difficult to read if used profusely. We therefore recommend adding a link to an API name if:

The best API names are "self-documenting", meaning they tell you basically what the API does. If the doc comment merely repeats the API name in sentence form, it is not providing more information. For example, if method description uses only the words that appear in the method name, then it is adding nothing at all to what you could infer. The ideal comment goes beyond those words and should always reward you with some bit of information that was not immediately obvious from the API name.

Quibble with Rule 2: I would not trust a variable name to describe the contents of the variable. (Or a constant.) I would not try to name a variable comprehensively either. If need be, use comments to say what is really going on. An expressive name is good, but a long name is not so good for several reasons; you can mistype it, or you can confuse it with other similar variable names. And if a variable only needs to exist for five lines, by all means call it n. Or tmp. Or tmp_1750.

a. The sample image we will use in this tutorial is a PNG image called cloudfront-test-image.png. Select the button on the right to download the sample image, and make sure to save it as cloudfront-test-image.png. 041b061a72




bottom of page