Author:halw

Date:2008-09-19T22:06:46.000000Z


git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@29 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
halw
2008-09-19 22:06:46 +00:00
parent a903078386
commit fc91cd5b1b
15 changed files with 19 additions and 85 deletions

View File

@@ -16,7 +16,7 @@ In this simple Tour, things have been set up so that all the files of interest,
<div> [[Image:index-7]] [[general/guided_tour/studio/index-7.png|(link)]] </div>
The contents of this <code> YOURDIR </code> directory include the following:
* First you see a number of files with the extension <span>.</span> <code> e </code>, for "Eiffel": <code> heir.e </code>, <code> invalid.e </code> and others. These are the Eiffel source files, each containing one class. The recommended convention is to store a class of name <code> CLASS_NAME </code> into a file of name <code> class_name </code> <code> .e </code>, where <code> class_name </code> is the lower-case version of <code> CLASS_NAME </code> ; here, file <code> heir.e </code> contains the class <code> HEIR </code> and so on. As you may remember, Eiffel is case-insensitive, but the standard convention for class names is to write them in all upper case. Calling the file <code> class_name </code> <code> .e </code> is only a recommendation, not an obligation; but you <span>are</span> required to store one class per file. This keeps things simple and facilitates project and configuration management.
* You also notice a file with an <code> ecf </code> extension. This is the configuration file that specifies this project. As you remember, the ECF file for this example was available as part of the delivery; we used it to compile the project. In most practical cases, however, you won't need to build an ECF; if you use the " <code> Create project </code>" option of EiffelStudio (remember the first screen [[EiffelStudio General: A Guided Tour|here]] ), EiffelStudio will build the ECF for you; if you change the Project Settings during a session, EiffelStudio will update the ECF. ECF are written in a xml notation.
* You also notice a file with an <code> ecf </code> extension. This is the configuration file that specifies this project. As you remember, the ECF file for this example was available as part of the delivery; we used it to compile the project. In most practical cases, however, you won't need to build an ECF; if you use the " <code> Create project </code>" option of EiffelStudio, EiffelStudio will build the ECF for you; if you change the Project Settings during a session, EiffelStudio will update the ECF. ECF are written in a xml notation.
* Finally you will notice a subdirectory called <code> EIFGENs </code>, for " <code> EIF </code>fel <code> GEN </code>eration<code>s</code>". <code> EIFGENs </code> is created and maintained by the compiler to store information about your project, including generated code for execution. EiffelStudio manages your project in such a way that <code> EIFGENs </code> can always be re-generated if need be; this means in particular that if things go wrong for any reason and you want to make a fresh start you can always delete this directory and recompile your system. This also means that you should not add any files into this directory, or modify any of its files, since a later compilation is free to change or regenerate whatever it chooses in <code> EIFGENs </code>.
Later on, we will see that EiffelStudio may generate three more subdirectories of the project directory: <code> Diagrams </code>, if you produce graphical system diagrams; <code> Documentation </code>, if you request system documentation, for example HTML; and <code> Metrics </code>, if you perform measurements on your system. Other than these directories, <code> EIFGENs </code> EiffelStudio will not touch anything in the project directory, so you may safely add and change whatever files and subdirectories you like.