summaryrefslogtreecommitdiffstats
path: root/docs/progGuideDB/preface.xml
blob: 1ad7b382bee9927634e8df7c16ff1575a2da07d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<preface id="preface">
  <title>Preface</title>

  <para>
    This programming guide does three things. It

    <itemizedlist spacing="compact">
      <listitem>
        <para>introduces the AspectJ language</para>
      </listitem>

      <listitem>
        <para>
          defines each of AspectJ's constructs and their semantics, and
        </para>
      </listitem>

      <listitem>
        <para>
          provides examples of their use.
        </para>
      </listitem>
    </itemizedlist>

    It includes appendices that give a reference to the syntax of AspectJ,
    a more formal description of AspectJ's semantics, and a description of
    limitations allowed by AspectJ implementations.
  </para>

  <para>
    The first section, <xref linkend="starting" />, provides a gentle
    overview of writing AspectJ programs. It also shows how one can
    introduce AspectJ into an existing development effort in stages,
    reducing the associated risk. You should read this section if this is
    your first exposure to AspectJ and you want to get a sense of what
    AspectJ is all about.
  </para>

  <para>
    The second section, <xref linkend="language" />, covers the features of
    the language in more detail, using code snippets as examples.  All the
    basics of the language is covered, and after reading this section, you
    should be able to use the language correctly.
  </para>

  <para>
    The next section, <xref linkend="examples" />, comprises a set of
    complete programs that not only show the features being used, but also
    try to illustrate recommended practice. You should read this section
    after you are familiar with the elements of AspectJ.
  </para>

  <para>
    Finally, there are two short chapters, one on <xref linkend="idioms" />
    and one on <xref linkend="pitfalls" />.
  </para>

  <para>
    The back matter contains several appendices that cover a <xref
    linkend="quick">quick reference</xref> to the language's syntax, a more
    in depth coverage of its <xref linkend="semantics">semantics</xref>,
    and a description of the latitude enjoyed by its <xref
    linkend="limitations">implementations</xref>.
  </para>

</preface>