mvc export to pdf : Convert .pdf to .jpg online application control utility html azure asp.net visual studio Delphi-Documentation-Guidelines0-part54

DevJET Software 
Delphi 
Documentation 
Guidelines 
Baoquan Zuo 
10/12/2010 
Convert .pdf to .jpg online - Convert PDF to JPEG images in C#.net, ASP.NET MVC, WinForms, WPF project
How to convert PDF to JPEG using C#.NET PDF to JPEG conversion / converter library control SDK
convert pdf file to jpg on; convert pdf images to jpg
Convert .pdf to .jpg online - VB.NET PDF Convert to Jpeg SDK: Convert PDF to JPEG images in vb.net, ASP.NET MVC, WinForms, WPF project
Online Tutorial for PDF to JPEG (JPG) Conversion in VB.NET Image Application
changing pdf to jpg on; convert pdf pages to jpg online
2/23 
Table of Contents 
1. Copyright ................................................................................................................................... 3 
2. Acknowledgements ................................................................................................................... 3 
3. Revision History ......................................................................................................................... 3 
4. Overview ................................................................................................................................... 4 
5. XML Documentation ................................................................................................................. 5 
5.1 Introduction .................................................................................................................. 5 
5.2 Section Tags ................................................................................................................... 6 
5.3 Block Tags ...................................................................................................................... 6 
5.4 Inline Tags ...................................................................................................................... 7 
5.5 Tag Usage ...................................................................................................................... 7 
6. XML Tag Reference .................................................................................................................... 7 
6.1 <c> ................................................................................................................................. 7 
6.2 <code> ........................................................................................................................... 8 
6.3 <example> ..................................................................................................................... 8 
6.4 <exception> ................................................................................................................... 9 
6.5 <include> ..................................................................................................................... 10 
6.6 <list> ............................................................................................................................ 10 
6.7 <note> ......................................................................................................................... 12 
6.8 <para> ......................................................................................................................... 13 
6.9 <param> ...................................................................................................................... 14 
6.10 <paramref> .................................................................................................................. 14 
6.11 <permission> ............................................................................................................... 15 
6.12 <preliminary> .............................................................................................................. 15 
6.13 <remarks> ................................................................................................................... 15 
6.14 <returns> ..................................................................................................................... 16 
6.15 <see> ........................................................................................................................... 16 
6.16 <seealso> ..................................................................................................................... 16 
6.17 <summary> ................................................................................................................. 17 
6.18 <threadsafety> ............................................................................................................ 18 
6.19 <typeparam> ............................................................................................................... 18 
6.20 <typeparamref> .......................................................................................................... 19 
6.21 <value> ........................................................................................................................ 19 
7. Write Documentation ............................................................................................................. 21 
8. Generate Documentation ....................................................................................................... 23 
9. References ............................................................................................................................... 23 
Online Convert Jpeg to PDF file. Best free online export Jpg image
Online JPEG to PDF Converter. Download Free Trial. Convert a JPG to PDF. You can drag and drop your JPG file in the box, and then start
best pdf to jpg converter; change format from pdf to jpg
Online Convert PDF to Jpeg images. Best free online PDF JPEG
Online PDF to JPEG Converter. Download Free Trial. Convert a PDF File to JPG. Drag and drop your PDF in the box above and we'll convert the files for you.
convert multi page pdf to jpg; c# pdf to jpg
3/23 
1. Copyright 
Copyright © 2010, DevJET Software. All rights reserved. 
This document may not be included in the distribution of any software application or any other 
document collection without the permission of the author. 
The author has made every effort in the preparation of this content to ensure the accuracy of the 
information. However, the information is provided without warranty, either express or implied. 
The author will not be held liable for any damages caused or alleged to be caused either directly 
or indirectly by this content. 
Delphi and RAD Studio are registered trademarks of Embarcadero Technologies, Inc. 
NDoc is a well-known open-source project which provides a documentation generator for .Net. 
2. Acknowledgements 
(Placeholder) 
3. Revision History 
Version 
Date 
Author 
Remarks 
V0.9.2 
Oct. 12
th
, 2010 
Baoquan Zuo 
Initial release 
To get the latest version of this document, please visit the website: 
DevJET Software 
http://www.devjet.net/ 
C# Image Convert: How to Convert Adobe PDF to Jpeg, Png, Bmp, &
This demo code just converts first page to jpeg image. String inputFilePath = @"C:\input.pdf"; String outputFilePath = @"C:\output.jpg"; // Convert PDF to jpg.
convert pdf to high quality jpg; batch pdf to jpg converter online
C# Image Convert: How to Convert Tiff Image to Jpeg, Png, Bmp, &
RasterEdge.XDoc.PDF.dll. This demo code will convert first page to jpeg image. C:\input.tif"; String outputFilePath = @"C:\output.jpg"; // Convert tiff to jpg.
change pdf to jpg format; changing pdf to jpg
4/23 
4. Overview 
When we want to learn a code library, we must read its documentation at first. A professional 
documentation will help us easily get the key points and understand the design intention of the 
author. It is no doubtful that one of the most impressive examples is MSDN.  
On the other hand, when we play the role of an author, we also need to write documentation to 
explain our code and design remarks, especially when working together with other developers. 
There are two major candidates in software documentation: 
 XML Documentation 
 Javadoc 
XML documentation was introduced by Microsoft to document .Net code while the format of 
Javadoc is created by Sun Microsystems to document java source files. 
Since the Delphi IDE has officially supported the XML documentation standard since Delphi 2006, 
so this document is based on XML Documentation. 
In the following sections, you will know more about the xml documentation style and the 
detailed syntax and remarks. 
The last sections will tell you how to easily and quickly write xml documentation in the IDE and 
generate documentation from the source code. 
C# Create PDF from images Library to convert Jpeg, png images to
Batch convert PDF documents from multiple image formats, including Jpg, Png, Bmp, Gif, Tiff, Bitmap, .NET Graphics, and REImage.
bulk pdf to jpg; conversion of pdf to jpg
VB.NET PDF Convert to Images SDK: Convert PDF to png, gif images
Resize converted image files in VB.NET. Convert PDF to Jpg, Png, Bmp, Gif, Tiff and Bitmap in ASP.NET. Embed PDF to image converter in viewer.
change from pdf to jpg on; convert multiple page pdf to jpg
5/23 
5. XML Documentation 
5.1 Introduction 
XML documentation was introduced by Microsoft to document C#/VB.net code. Delphi followed 
this standard later and the IDE and compiler has supported the style since Delphi 2006. 
When the build-in Help Insight feature is enabled, a popup window will be shown to display a 
simple documentation of the current code element under the mouse hover. In addition, the 
documentation could be surrounded in a region so that you can fold it when needed. 
As you can see, xml documentation is actually a well-formed XML document and starts with /// 
as prefix. You can use some meaningful tags and write descriptions within tags. Some tags may 
contain attributes. 
You can customize your own tags but there have been so many common tags recommended by 
Microsoft. Most documentation generator support the recommended usage. 
All xml tags could be divided into the following categories: 
 Section Tags 
Defines a top-level section in a topic. e.g. Summary, Remarks, Examples section. 
 Block Tags 
Adds a block to a section. e.g. a paragraph, an image or a code snippet. 
 Inline Tags 
Formats the effect of a text. e.g. bold, italic, underline, hyperlink. 
 Usage Notes: 
VB.NET PDF - Convert PDF with VB.NET WPF PDF Viewer
Jpeg, VB.NET compress PDF, VB.NET print PDF, VB.NET merge PDF files, VB.NET view PDF online, VB.NET Convert PDF to image formats, such as PNG, JPG, BMP and
.net pdf to jpg; batch pdf to jpg
VB.NET Create PDF from images Library to convert Jpeg, png images
Components to batch convert PDF documents in Visual Basic .NET class. Support create PDF from multiple image formats in VB.NET, including Jpg, Png, Bmp, Gif
convert .pdf to .jpg online; convert pdf to jpg file
6/23 
 If you want angle brackets to appear in the text of a documentation comment, use &lt; and 
&gt;. For example, the string "&lt;text in angle brackets&gt;" will appear as <text in angle 
brackets>. 
 The cref attribute in a tag means a reference to a member. You should use this form in 
Delphi: “Namespace|Element Path”. e.g. <see cref=”Spring.Utils|TDriveInfo.GetDrives” /> 
 To reference a generic type or member as a target in the cref attribute, you may use curly 
braces around the "T". e.g. <see cref="Spring.Collections|IList {T}"/>. 
 All common HTML tags such as <p>, <b>, <i>, <u>, <a>, <img>, etc. should be also 
supported. 
5.2 Section Tags 
Section tags are used to define the content of the different sections of the documentation of a 
type or member. These tags are used as top-level tags. 
The following tags are section tags: 
Tag 
Description 
<summary> 
A short description of the code element. 
<remarks> 
Additional information about the code element, supplementing the 
description in the <summary> tag. 
<param> 
A parameter of the code element which may be a method, indexed 
property or a routine. 
<typeparam> 
A type parameter of a generic type or a generic method 
<returns> 
A description of the return value of a member. 
<value> 
A description of the value of a property, field, constant or a variable. 
<example> 
An example of demonstrating how to use the code. 
<exception> 
An exception that may be raised the code element. 
<permission> 
Security permissions required to access a member. 
<seealso> 
Adds an entry, which may be a link to a member or a URI address, to 
the See Also section. 
<include> 
References an xml node in an include file that contains one or more 
documentation section tags. 
<preliminary> 
[NDoc Compatible] 
Represents that the API is preliminary and will be changed in future. 
<threadsafety> 
[NDoc Compatible] 
Describes how the code behaviors in multi-threaded context. 
5.3 Block Tags 
Block tags format text within the top-level tags. They are typically used to add structure to the 
text inside Remarks and Examples sections. 
7/23 
Tag 
Description 
<para> 
A paragraph. 
<code> 
A block of code. 
<list> 
A numbered list, bulleted list or a definition list. 
<note> 
[NDoc Compatible] 
A formatted note block. 
5.4 Inline Tags 
Inline tags are typically used inside block tags. 
Tag 
Description 
<c> 
A text as an inline code. 
<paramref> 
A reference to a parameter of a method, a routine or an indexed 
property. 
<typeparamref> 
A reference to a type parameter of a generic type or a generic method. 
<see> 
A link to a member or a hyper link. 
5.5 Tag Usage 
6. XML Tag Reference 
6.1 <c> 
This tag is used to mark the text as inline code. 
Syntax: 
<c>text</c> 
Remarks: 
Element 
Sections 
Classes/Records 
Summary, Remarks , Examples and Thread Safety 
Interfaces 
Summary, Remarks, Examples 
Methods 
Summary
Remarks
Parameters
Returns
and 
Exceptions
Properties 
Summary
Value
Remarks
and 
Exceptions
Fields 
Summary
Constants/Variable 
Summary
and 
Value
Delegates 
Summary
Remarks
Parameters
and 
Returns
8/23 
The <c> tag gives you a way to indicate that text within a description should be marked as 
code. Use <code> to indicate multiple lines as code. 
Examples: 
/// 
<summary>Represents the class type of <c>TCustomAttribute</c>.</summary> 
TAttributeClass = class of TCustomAttribute; 
Examples Out: 
6.2 <code> 
This tag is used to add a code snippet. 
Syntax: 
<code [lang="language"] >content</code> 
Parameters: 
lang: 
The language of the code. 
Remarks: 
Examples: 
See examples in the <example > tag. 
6.3 <example> 
Use this tag to insert an example to demonstrate how to use the code element. 
Syntax: 
<example>description</example> 
Remarks: 
Examples: 
///  <example>  
///    The following code demonstrates how to create a new guid and use it in  
///    OO-style:  
///    <code lang="Delphi">  
9/23 
///  procedure TestGuidHelper;  
///  var  
///    guid: TGuid;  
///  begin  
///    // generates a new guid.  
///    guid := TGuid.NewGuid;  
///    // this guid must not be empty.  
///    Assert(not guid.IsEmpty);  
///    // print the string representation  
///    Writeln(guid.ToString);  
///    // print the quoted string  
///    Writeln(guid.ToQuotedString);  
///    // This guid must equal to itself.  
///    Assert(guid.Equals(guid));  
///  end;  
///  </code>  
///  </example>
Examples Out: 
6.4 <exception> 
This tag is used to describe which exceptions will be raised by the method or routine. 
Syntax: 
<exception cref="member">description</exception> 
Remarks: 
The cref attribute references to an exception class. 
10/23 
Examples: 
/// 
<exception cref="EFileNotFoundException">Raised if the target file does 
/// 
not exist.</exception> 
/// 
<exception cref="EAnotherException">Raised if another condition is 
/// 
satisfied.</exception> 
procedure CheckFileExists(const fileName: string); 
Examples Out: 
6.5 <include> 
Allow you to refer to the comments in the specified file. 
Syntax: 
<include file='filename' path='tagpath[@name="id"]' /> 
Remarks: 
WARNING: Not supported by most tools including Documentation Insight. 
6.6 <list> 
Use <list> tag to insert a numbered list, bulleted list or a definition table. 
Syntax: 
<list type="bullet" | "number" | "table"> 
<listheader> 
<term>term</term>  
<description>description</description> 
</listheader>  
<item> 
<term>term</term> 
<description>description</description> 
</item> 
</list> 
Parameters: 
term 
A term to define, which will be defined in description
description 
Either an item in a bullet or numbered list or the definition of a term
Remarks: 
Documents you may be interested
Documents you may be interested