Documentation

Documentation
Зачем?
!"#$%&'( )%$*+"" %,-%,.$'#&
О чем пишут?
• !"# $%"&%'(() $"-*+,- ",./0'/, 1'
."$%"*: !"# $%#&'(#)&"?
• 2"3+(/1,'4-5 ",./0'/, 1' ."$%"*):
*+, -"&. $#/01#2+"0'3? *+, -"&.
/4567 (-887,"&297:)
$#/01#2+"0'3? *+,#2+ 8&/#'#8&3
&'$#/01#2+9&3 -"#;#?
(. 6'.-*-("*,- ", 3'0/*,.'
#"3+(/1,'4--)
О чем пишут?
• !'3 .*/ 1'*,%"-,7 - 8)*,%"
$%-*,+$-,7 3 %'8",/
• 9-:"*";*3-/ -6)*3'1-5 '.,"%' 3"#'
$" $"."#+ 6'3".)%-*,)< %/=/1->
• !'3 $":76".',7*5 .1+,%/11-(-1*,%+(/1,'(- ("$-*'1-/ API)
• - ,.#.
Помогает?
• ?".-03- $/%/*,'@, #/%&',7 8"://
"$),1)< $%"&%'((-*,". $"
$+*,53'(
• A$),1)/ $%"&%'((-*,) 6'15,)
*."-(- 6'#'0'(- - 1/ ",.:/3'@,*5
Но!
?/ *(",%5 1' .*/ $:@*) $"0,- 1-3,"
1/ $-=/, #"3+(/1,'4-@
Auto documentation
Javadoc
Javadoc
/**
* Проверяет, допустимый ли ход.
* Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4);
* @param theFromFile Вертикаль, на которой находится фигура (1=a, 8=h)
* @param theFromRank Горизонталь, на которой находится фигура (1...8)
* @param theToFile
Вертикаль клетки, на которую выполняется ход (1=a, 8=h)
* @param theToRank
Горизонталь клетки, на которую выполняется ход (1...8)
* @return true, если ход допустим, и false, если недопустим
*/
boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank)
{
. . .
}
Javadoc
Javadoc — B," API #"3+(/1,'4-5
(-*$":76+/,*5 1/$"*%/#*,./11" . 3"#/
- ,":73" . 1/()
Javadoc
2:5 3"($-:54-- HTML
#"3+(/1,'4-- *+C/*,.+/, (1"&"
-1*,+(/1,".
• javadoc (,":73" $"# java)
• doxygen (+1-./%*':71)> $"# .*/
56)3-)
reStructuredText
• Wiki-style #"3+(/1,'4-5 ($-=/( rst
;'>:) *$/4-':71"> %'6(/,3- $"*:/ 3"($-:54-- $":+0'/(
&",".)> *'>, #"3+(/1,'4-- . HTML
*" **):3'(- - $"-*3"()
• API #"3+(/1,'4-5
reStructuredText
def load_workbook(filename, use_iterators=False):
"""Open the given filename and return the workbook
:param filename: the path to open or a file-like object
:type filename: string or a file-like object open in binary mode
c.f., :class:`zipfile.ZipFile`
:param use_iterators: use lazy load for cells
:type use_iterators: bool
:rtype: :class:`openpyxl.workbook.Workbook`
.. note::
When using lazy load, all worksheets will
be :class:`openpyxl.reader.iter_worksheet.IterableWorksheet`
and the returned workbook will be read-only.
"""
pass
Sphinx reST
• http://sphinx.pocoo.org/rest.html
3%',3"/ "$-*'1-/ 56)3' %'6(/,3- *
$%-(/%'(- reST
• D*,'1'.:-.'/,*5 0/%/6 easy_install
$ easy_install Sphinx
Sphinx reST (сборка)
• $ sphinx-quickstart
• *:/#+/( -1*,%+34-5( ...
• $-=/( #"3+(/1,'4-@
• $ make html
• . $'$3/ _build ",3%).'/( index.html .
:@8"( 8%'+6/%/
Вопросы?