📄 idldoc-help.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!-- Generated by IDLdoc on Mon Jun 13 11:04:16 2005 -->
<HEAD>
<TITLE>Help</TITLE>
<LINK REL=stylesheet TYPE="text/css" HREF="idldoc.css" TITLE="main_style">
<SCRIPT>
function setTitle()
{
parent.document.title="Help (Research Systems, Inc.)";
}
</SCRIPT>
</HEAD>
<BODY CLASS="standard" onload="setTitle();">
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="100%">
<TR><TD VALIGN="TOP" BGCOLOR="#DDDDFF" style="BORDER-TOP: 1px solid #BBBBFF; BORDER-BOTTOM: 1px solid #6666AA; BORDER-LEFT: 1px solid #BBBBFF; BORDER-RIGHT: 1px solid #6666AA;">
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0">
<TR CLASS="navbar">
<TD class="navbar_unselected"> <A HREF="overview.html">Overview</A> </TD>
<TD class="navbar_unselected"> Directory </TD>
<TD class="navbar_unselected"> <A HREF="full-index.html">Index</A> </TD>
<TD class="navbar_unselected"> <A HREF="search-page.html">Search</A> </TD>
<TD class="navbar_unselected"> File </TD>
<TD class="navbar_unselected"> Source </TD>
<TD class="navbar_selected"> Help </TD>
<TD class="navbar_unselected"> Etc </TD>
</TR>
</TABLE>
</TD>
<TD> </TD>
<TD ROWSPAN="3" ALIGN="right"><FONT CLASS="logo"><NOBR>Research Systems, Inc.</NOBR></FONT><BR><FONT CLASS="version"><NOBR>IDL 6.2 Beta</NOBR></FONT><BR><FONT CLASS="version" STYLE="font-weight: bold">Developer Documentation</FONT></TD>
</TR>
<TR><TD CLASS="navbar_small"> prev file | next file <NOBR><A HREF="idldoc-help.html" TARGET="_top">view single page</A> | <A HREF="index.html" TARGET="_top">view frames</A> | update routines</NOBR></TD></TR>
<TR><TD CLASS="navbar_small">SUMMARY: fields | routine DETAILS: routine</TD></TR>
<TR><TD></TD></TR>
</TABLE>
<HR CLASS="divider">
<H1>Help on IDLdoc output</H1>
<H2>Routine summary</H2>
The routine summary simply provides the calling sequence for each routine in
the file and the first sentence of the detailed description.
<H2>Routine Details</H2>
The routine details sections gives a possibly longer description of the routine
as well as a tables of the parameters and keywords accepted by the routine.
All the parameters and keywords of the routine will be in these tables
regardless if they have been commented using IDLdoc.
<H3>Notes on routine attributes</H3>
See the IDLdoc page for IDLdoc itself for a full listing of the attributes of
a routine.
<P>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="minor_listing">
<TR bgcolor="#EEEEFF">
<TD width="1%" valign="top"><B>Attribute</B></TD>
<TD><B>Description</B></TD>
</TR>
<TR>
<TD valign="top">abstract</TD>
<TD>The routine name will be italicized if the routine is marked
"abstract" (meaning it is not implemented, it is provided for its
interface). This is generally used in only object-oriented
programming.
</TD>
</TR>
<TR>
<TD valign="top">private</TD>
<TD>This routine is not intended to be called except by other routines
in the same file. In other words it is a "helper routine".
</TD>
</TR>
</TABLE>
<H3>Keyword and parameter attributes</H3>
<TABLE CELLPADDING="3" CELLSPACING="0" CLASS="minor_listing">
<TR bgcolor="#EEEEFF">
<TD width="1%" valign="top"><B>Attribute</B></TD>
<TD><B>Description</B></TD>
</TR>
<TR>
<TD valign="top">in</TD>
<TD>indicates that the argument is intended to be passed into the
routine.
</TD>
</TR>
<TR>
<TD valign="top">out</TD>
<TD>indicates that the argument is intended to be used to pass a value
out of the routine. A named variable must be passed to the routine
to pass a value back to the calling level.
</TD>
</TR>
<TR>
<TD valign="top">optional</TD>
<TD>indicates the argument is optional; optional parameters and keywords
are also placed inside brackets ([]) in the routine summary.
</TD>
</TR>
<TR>
<TD valign="top">required</TD>
<TD>indicates the argument is required</TD>
</TR>
<TR>
<TD valign="top">type</TD>
<TD>"type" indicates the type of the variable. Can be used indicate a
group of types, a specific type, an array of a certain type, etc.
Boolean keywords are indicated by a /KEYWORD_NAME in the routine
summary.
</TD>
</TR>
</TABLE>
<P>
<P>
<HR class="divider">
<FONT CLASS="tagline">Produced by IDLdoc 1.6 on Mon Jun 13 11:04:16 2005</FONT><BR>
</BODY></HTML>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -