Документирование исходных текстов (javadoc)
DESCRIPTION
Документирование исходных текстов (javadoc)TRANSCRIPT
- 1.
-
- 11 2007
2.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
3.
- () ()
- Open Source
4.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
5.
- (setter' getter', , )
/** * : . * *
- true
* *
- false
* * @param column * @return **/ public boolean isCellEditable(int column) { return column % 2 == 0 ? true : false; } 6.
/** * . ***@throwsXMLConfigurationParsingException */ public voidparseHistoryNotEmbeddedDB()throwsXMLConfigurationParsingException { return ; /* * InputStream is = * Thread.currentThread().GetContextClassLoader(). getResourceAsStream("ru/magnetosoft/magnet/em/cfg/db-configuration-not-embedded.xml"); * String configXml = readStringFromStream(is); * XmlConfigurationParserImpl parser = new * XmlConfigurationParserImpl(configXml); IEmConfiguration res = * parser.parse(); assertNotNull(res); * assertFalse(res.getOperationHistoryStorageConfiguration().isEmbeddedStorage()); * assertEquals("HSQLDB", * res.getOperationHistoryStorageConfiguration().getStorageDBType()); */ } 7.
- ,
/** * . ***@paramcontextName *@paramobjectRelationManager *@paramxmlObjectPersister *@paramohm *@paramsnm *@paraminitializationLatch *@return */ public staticEmEngine newInstance(String contextName, IXmlObjectRelationManager objectRelationManager, IXmlObjectPersister xmlObjectPersister, OperationHistoryManager ohm, ISearchNotificationManager snm, CountDownLatch initializationLatch) { ... ... } 8.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
9. JavaDoc':
- . , .
- :
- /**
- **/
- HTML javadoc , .
- /**
- .
-
,
.
- @since 0.2
- @author Malyshkin Fedor ( [email_address] ) **/
10. JavaDoc':
- javadoc :
-
- , ( ).
-
- , HTML .
-
- ( )
-
- ( )
-
- ( )
-
- Javadoc
11. JavaDoc': 12.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
13. JavaDoc':
- @see ( : packageName.className#methodName(argument1, argument2,...), , (.. ) ). .. :
-
- @see java.io.RandomAccessFile#RandomAccessFile(File, String)
-
- :
-
- @see CreationManager
14. JavaDoc':
- @author
-
- @author Mary Wollstonecraft
-
- @author Jack Kent, Peggy Parish, Crockett Johnson
- @version ( )
-
- @version 493.0.1beta
- @since
-
- @since 493.0.1beta
- @param ( )
-
- @param column
-
- @param row
- @return
- @throws ( )
-
- @throws XmlMagnetException
-
- @throws EntityManagerException
15. JavaDoc':
- @link , . .
-
- {@link #getInstance(InputStream)}
-
- {@link #getInstance(String)}
-
- {@link java.io.InputStream(String)}
16. JavaDoc':
-
- . package.html .
-
- HTML .
-
- , .
-
- -, .
17.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
18. JavaDoc':
- /**
- * EntityManger .
- *
- *
- *
- * EntityManager, -.
- *
- *
- * Java Bean' XML
- * , .
- *
- *
- *
- * {@link #getInstance(InputStream)} {@link #getInstance(String)}
- *
- *
- * @created 09.11.2006
- * @version $Revision 738 $
- * @author MalyshkinF
- * @since 0.2.2
- */
- public class EntityManagerInvoker {
19. JavaDoc':
- /**
- * .
- *
- * .
- * List (
- * ) . -
- * - .
- *
- * .
- * .
- *
- * @param object
- * /.
- * @return /
- * @throws XmlMagnetException XML
- * @throws EntityManagerException
- */
- public Object insert(Object object) throws XmlMagnetException, EntityManagerException {
20.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
21. Maven 2 & JavaDoc'
- javadoc
- pom.xml javadoc
- javadoc'
- ...
22. Maven 2 & JavaDoc'
- javadoc' plugin javadoc:
-
- $malyshkiknf> mvn javadoc:javadoc
- XML:
-
- ...
-
-
- ...
-
- org.apache.maven.plugins
- maven-javadoc-plugin
-
-
- ...
-
- ...
23. Maven 2 & JavaDoc'
- javadoc' . pom.xml.
-
-
- ...
-
-
-
- ...
-
-
- org.apache.maven.plugins
-
- maven-javadoc-plugin
-
- ...
-
- true
-
- ...
-
-
- ...
-
-
- ...
24. Maven 2 & JavaDoc'
- .
-
-
-
- Clients Partru.magnetosoft.magnet.em.client:
-
-
-
-
-
- ru.magnetosoft.magnet.em.client.cfg
-
-
- Common Part
-
-
-
- ru.magnetosoft.magnet.em.annotations:
-
-
-
-
-
-
- ru.magnetosoft.magnet.em.metadata:
-
-
-
-
-
-
-
- ru.magnetosoft.magnet.em.xml:
-
-
-
-
-
-
-
- ru.magnetosoft.magnet.em.xml.parts:
-
-
-
-
-
-
-
- ru.magnetosoft.magnet.em.xml.parts.v2:
-
-
-
25.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
26. NetBeans & JavaDoc'
- JavaDoc'
- JavaDoc'
- JavaDoc'
- P.S.: NetBeans 6
27. NetBeans & JavaDoc'
- JavaDoc' - NetBeans
28. NetBeans & JavaDoc'
- JavaDoc
29. NetBeans & JavaDoc'
- . Ctrl+Space...
30. NetBeans & JavaDoc'
- JavaDoc.
- ...
-
- ....
... 31.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
32. JavaDoc'
- HTTP Server mg-sv01 g-sv01javadocs
33.
- JavaDoc'
-
- Maven2 & JavaDoc'
-
- NetBeans & JavaDoc'
-
- JavaDoc'
-
- TODO
34. TODO
- NetBeans , . , .