ນີ້ແມ່ນຄໍາສັ່ງ epydocgui ທີ່ສາມາດດໍາເນີນການໄດ້ໃນ OnWorks ຜູ້ໃຫ້ບໍລິການໂຮດຕິ້ງຟຣີໂດຍໃຊ້ຫນຶ່ງໃນຫຼາຍບ່ອນເຮັດວຽກອອນໄລນ໌ຂອງພວກເຮົາເຊັ່ນ Ubuntu Online, Fedora Online, Windows online emulator ຫຼື MAC OS online emulator
ໂຄງການ:
NAME
epydocgui - ການໂຕ້ຕອບຮູບພາບກັບ epydoc
ສະຫຼຸບສັງລວມ
epidocgui [project.prj | ໂມດູນ... ]
epidoc -h
epidoc -V
ລາຍລະອຽດ
epidocgui ແມ່ນການໂຕ້ຕອບແບບກາຟິກກັບ epydoc, ເຊິ່ງສ້າງເອກະສານ API ສໍາລັບ Python
ໂມດູນແລະຊຸດ, ໂດຍອີງໃສ່ docstrings ຂອງພວກເຂົາ. ພາສາ markup ທີ່ມີນ້ໍາຫນັກເບົາເອີ້ນວ່າ
epitext ສາມາດໃຊ້ເພື່ອຈັດຮູບແບບ docstrings, ແລະເພື່ອເພີ່ມຂໍ້ມູນກ່ຽວກັບຊ່ອງຂໍ້ມູນສະເພາະ,
ເຊັ່ນ: ຕົວກໍານົດການແລະຕົວແປ instance.
ເອກະສານ API ທີ່ຜະລິດໂດຍ epidocgui ປະກອບດ້ວຍຊຸດຂອງໄຟລ໌ HTML. ສອງ
ໄດເລກະທໍລີຍ່ອຍຖືກສ້າງຂື້ນສໍາລັບເອກະສານສາທາລະນະແລະເອກະຊົນ. ພາຍໃນແຕ່ລະຄົນ
ໄດເລກະທໍລີຍ່ອຍ, ທຸກໆຊັ້ນຮຽນແລະໂມດູນຖືກບັນທຶກໄວ້ໃນເອກະສານຂອງຕົນເອງ. ເອກະສານດັດສະນີ, ກ
ໄຟລ໌ຕົ້ນໄມ້, ແລະໄຟລ໌ຊ່ວຍເຫຼືອກໍ່ຖືກສ້າງຂື້ນ. ຖ້າຫາກວ່າທ່ານເລືອກເອົາ ນໍາ ທາງເລືອກ, ຫຼັງຈາກນັ້ນ a
ຕາຕະລາງເນື້ອໃນທີ່ອີງໃສ່ກອບແມ່ນຍັງຜະລິດ.
OPTIONS
project.prj
ຊື່ຂອງໄຟລ໌ໂຄງການທີ່ບັນທຶກໄວ້ດ້ວຍ epidocgui. ໄຟລ໌ໂຄງການບັນທຶກ ກ
ບັນຊີລາຍຊື່ຂອງໂມດູນທີ່ກ່ຽວຂ້ອງ, ແລະທາງເລືອກທີ່ຄວນຈະຖືກນໍາໃຊ້ເພື່ອສ້າງ
ເອກະສານສໍາລັບໂມດູນເຫຼົ່ານັ້ນ.
ໂມດູນ...
ບັນຊີລາຍຊື່ຂອງໂມດູນທີ່ຄວນຈະເປັນເອກະສານ. ໂມດູນສາມາດຖືກກໍານົດໂດຍໃຊ້
ຊື່ໂມດູນ (ເຊັ່ນ: os.path), ຊື່ໄຟລ໌ (ເຊັ່ນ: epidoc/epytext.py), ຫຼືໄດເລກະທໍລີ
ຊື່ (ເຊັ່ນ epidoc/). ຊື່ Directory ລະບຸແພັກເກັດ, ແລະຖືກຂະຫຍາຍໄປ
ປະກອບມີໂມດູນຍ່ອຍແລະຊຸດຍ່ອຍທັງຫມົດ.
-ຊ, -- ຊ່ວຍເຫຼືອ, -- ການນໍາໃຊ້, -?
ສະແດງຂໍ້ຄວາມການນໍາໃຊ້.
-V, - ການປ່ຽນແປງ
ພິມສະບັບຂອງ Epydoc.
HTML ເອກະສານ
ເອກະສານ API ທີ່ຜະລິດໂດຍ epidoc ປະກອບດ້ວຍໄຟລ໌ດັ່ງຕໍ່ໄປນີ້:
index.html
ຈຸດເຂົ້າມາດຕະຖານສໍາລັບເອກະສານ. ປົກກະຕິ, index.html ເປັນ
ໄຟລ໌ດັດສະນີກອບ, ເຊິ່ງກໍານົດສາມເຟຣມ: ສອງເຟຣມຢູ່ເບື້ອງຊ້າຍຂອງ
ຕົວທ່ອງເວັບປະກອບມີຕາຕະລາງເນື້ອໃນ, ແລະກອບຕົ້ນຕໍຢູ່ເບື້ອງຂວາ
ຂອງປ່ອງຢ້ຽມມີຫນ້າເອກະສານ. ແຕ່ຖ້າຫາກວ່າ --no-frames ທາງເລືອກແມ່ນ
ໃຊ້ແລ້ວ index.html ຈະປ່ຽນເສັ້ນທາງຜູ້ໃຊ້ໄປຫາຫນ້າເທິງຂອງໂຄງການ.
m-module.html
ເອກະສານ API ສໍາລັບໂມດູນ. ໂມດູນ ແມ່ນຊື່ຈຸດທີ່ສົມບູນຂອງ
ໂມດູນ, ເຊັ່ນ sys or epidoc.epytext.
c-class.html
ເອກະສານ API ສໍາລັບປະເພດ, ຂໍ້ຍົກເວັ້ນ, ຫຼືປະເພດ. c ແມ່ນສົມບູນ
dotted ຊື່ຂອງຫ້ອງຮຽນ, ເຊັ່ນ: epidoc.epytext.Token or array.ArrayType.
tree.html
ໂມດູນ ແລະ ລຳດັບຊັ້ນຮຽນ.
indices.html
ຄຳສັບ ແລະຕົວຊີ້ວັດຕົວລະບຸ.
help.html
ຫນ້າຊ່ວຍເຫຼືອສໍາລັບໂຄງການ. ຫນ້ານີ້ອະທິບາຍວິທີການນໍາໃຊ້ແລະນໍາທາງ
ຫນ້າເວັບທີ່ຜະລິດໂດຍ Epydoc.
toc.html
ຕາຕະລາງເນື້ອໃນລະດັບສູງສຸດ. ໜ້ານີ້ສະແດງຢູ່ໃນມຸມຊ້າຍເທິງ
ກອບ, ແລະສະຫນອງການເຊື່ອມຕໍ່ກັບ toc-everything.html ແລະ toc-m-ໂມດູນ.html
ໄຟລ໌. toc.html ບໍ່ໄດ້ຖືກສ້າງຂຶ້ນຖ້າຫາກວ່າ --no-frames ທາງເລືອກແມ່ນຖືກນໍາໃຊ້.
toc-everything.html
ຕາຕະລາງເນື້ອໃນສໍາລັບໂຄງການທັງຫມົດ. ຫນ້ານີ້ແມ່ນສະແດງຢູ່ໃນ
ຂອບຊ້າຍລຸ່ມ, ແລະສະຫນອງການເຊື່ອມຕໍ່ກັບທຸກຫ້ອງຮຽນ, ປະເພດ, ຂໍ້ຍົກເວັ້ນ, ຫນ້າທີ່,
ແລະຕົວແປທີ່ກໍານົດໂດຍໂຄງການ. toc-everything.html ບໍ່ໄດ້ຖືກສ້າງຂຶ້ນຖ້າຫາກວ່າ
ໄດ້ --no-frames ທາງເລືອກແມ່ນຖືກນໍາໃຊ້.
toc-m-ໂມດູນ.html
ຕາຕະລາງເນື້ອໃນສໍາລັບໂມດູນ. ໜ້ານີ້ສະແດງຢູ່ໃນມຸມຊ້າຍລຸ່ມ
ກອບ, ແລະສະຫນອງການເຊື່ອມຕໍ່ກັບທຸກຫ້ອງຮຽນ, ປະເພດ, ຂໍ້ຍົກເວັ້ນ, ຫນ້າທີ່, ແລະ
ຕົວແປທີ່ກໍານົດໂດຍໂມດູນ. ໂມດູນ ແມ່ນຊື່ຈຸດທີ່ສົມບູນຂອງ
ໂມດູນ, ເຊັ່ນ sys or epidoc.epytext. toc-m-ໂມດູນ.html ບໍ່ໄດ້ຖືກສ້າງຂຶ້ນຖ້າຫາກວ່າ
ໄດ້ --no-frames ທາງເລືອກແມ່ນຖືກນໍາໃຊ້.
epidoc.css
CSS stylesheet ໃຊ້ເພື່ອສະແດງຫນ້າ HTML ທັງຫມົດ.
ໂດຍຕົວຢ່າງ, epidoc ສ້າງສອງໄດເລກະທໍລີຍ່ອຍໃນໄດເລກະທໍລີຜົນຜະລິດ: ສາທາລະນະ ແລະ ສ່ວນຕົວ.
ແຕ່ລະໄດເລກະທໍລີປະກອບດ້ວຍໄຟລ໌ທັງຫມົດທີ່ລະບຸໄວ້ຂ້າງເທິງ. ແຕ່ຖ້າຫາກວ່າ -- ບໍ່ມີສ່ວນຕົວ ທາງເລືອກ
ຖືກນໍາໃຊ້, ຫຼັງຈາກນັ້ນບໍ່ມີໄດເລກະທໍລີຍ່ອຍຖືກສ້າງຂຶ້ນ, ແລະເອກະສານສາທາລະນະຖືກຂຽນ
ໂດຍກົງກັບໄດເລກະທໍລີຜົນຜະລິດ. ແບ່ງອອກເປັນຫ້າປະເພດ: ຄວາມຜິດພາດການນໍາເຂົ້າ; epitext
ຄວາມຜິດພາດ; ເຕືອນ epitext; ການເຕືອນໄພພາກສະຫນາມ; ແລະຄວາມຜິດພາດການກວດກາ. ເມື່ອໃດທີ່ epidoc
ພົບກັບຄວາມຜິດພາດ, ມັນອອກຂໍ້ຄວາມເຕືອນໄພທີ່ອະທິບາຍຄວາມຜິດພາດ, ແລະພະຍາຍາມ
ສືບຕໍ່ສ້າງເອກະສານ.
ຄວາມຜິດພາດໃນການນໍາເຂົ້າຊີ້ໃຫ້ເຫັນວ່າ epydoc ບໍ່ສາມາດນໍາເຂົ້າໂມດູນໄດ້. ໂດຍທົ່ວໄປຄວາມຜິດພາດການນໍາເຂົ້າ
ປ້ອງກັນ epydoc ຈາກການສ້າງເອກະສານສໍາລັບໂມດູນໃນຄໍາຖາມ. Epydoc ສາມາດເຮັດໄດ້
ສ້າງຄວາມຜິດພາດການນໍາເຂົ້າຕໍ່ໄປນີ້:
ບໍ່ດີ ໂມດູນ ຊື່ ໂມດູນ
Epydoc ພະຍາຍາມນໍາເຂົ້າ ໂມດູນ, ແຕ່ ໂມດູນ ບໍ່ແມ່ນຊື່ທີ່ຖືກຕ້ອງຂອງ Python
module
ສາມາດ ບໍ່ ຊອກຫາ a UID ສໍາລັບການ link-ເປົ້າຫມາຍ
Epydoc ບໍ່ສາມາດຊອກຫາວັດຖຸທີ່ອ້າງອີງໂດຍການກໍ່ສ້າງເຊື່ອມຕໍ່ໃນແຖວ
(L{...}). ນີ້ປົກກະຕິແລ້ວແມ່ນເກີດມາຈາກ typo ໃນການເຊື່ອມຕໍ່.
ສາມາດ ບໍ່ ການນໍາເຂົ້າ ໂມດູນ
Epydoc ພະຍາຍາມນໍາເຂົ້າ ໂມດູນ, ແຕ່ມັນລົ້ມເຫລວ. ນີ້ມັກຈະເກີດຂື້ນເມື່ອ
ໂມດູນ ຍົກຂໍ້ຍົກເວັ້ນ.
ເອກະສານ ບໍ່ ບໍ່ ມີຢູ່ແລ້ວ
Epydoc ພະຍາຍາມນໍາເຂົ້າໂມດູນທີ່ມີຢູ່ໃນ ເອກະສານ, ແຕ່ ເອກະສານ ບໍ່
ມີຢູ່ແລ້ວ.
ຂໍ້ຜິດພາດຂອງ Epytext ແມ່ນເກີດມາຈາກ epytext docstrings ທີ່ມີ markup ທີ່ບໍ່ຖືກຕ້ອງ. ທຸກຄັ້ງທີ່
ກວດພົບຂໍ້ຜິດພາດຂອງ epytext, docstring ໃນຄໍາຖາມຖືກປະຕິບັດເປັນ plaintext docstring.
Epydoc ສາມາດສ້າງຂໍ້ຜິດພາດຂອງ Epytext ຕໍ່ໄປນີ້:
ບໍ່ດີ ການເຊື່ອມຕໍ່ ເປົ້າຫມາຍ.
ເປົ້າໝາຍທີ່ກຳນົດໄວ້ສຳລັບການສ້າງລິ້ງໃນແຖວ (L{...}) ບໍ່ດີ
ສ້າງຕັ້ງຂຶ້ນ. ເປົ້າໝາຍການເຊື່ອມໂຍງຕ້ອງເປັນຕົວລະບຸ python ທີ່ຖືກຕ້ອງ.
ບໍ່ດີ ປະເພດ ເປົ້າຫມາຍ.
ເປົ້າໝາຍທີ່ລະບຸໄວ້ສໍາລັບການກໍ່ສ້າງ uri inline (U{...}) ບໍ່ແມ່ນຮູບແບບທີ່ດີ.
ໂດຍທົ່ວໄປແລ້ວອັນນີ້ເກີດຂຶ້ນຖ້າ inline markup ແມ່ນຕິດຢູ່ໃນເປົ້າໝາຍ URI.
Fields ຕ້ອງ be at ໄດ້ top ລະດັບ.
ບັນຊີລາຍຊື່ຂອງຊ່ອງຂໍ້ມູນ (@ພາຣາມ, ແລະອື່ນໆ) ແມ່ນຖືກບັນຈຸໂດຍບາງໂຄງສ້າງບລັອກອື່ນໆ
(ເຊັ່ນ: ບັນຊີລາຍຊື່ຫຼືພາກສ່ວນ).
Fields ຕ້ອງ be ໄດ້ ສຸດທ້າຍ ອົງປະກອບ.
ບັນຊີລາຍຊື່ຂອງຊ່ອງຂໍ້ມູນ (@ພາຣາມ, ແລະອື່ນໆ) ບໍ່ແມ່ນຢູ່ໃນຕອນທ້າຍຂອງ docstring.
ຫົວຂໍ້ ຕ້ອງ ເກີດຂຶ້ນ at top ລະດັບ.
ຫົວຂໍ້ແມ່ນ contianed ໃນບາງໂຄງສ້າງບລັອກອື່ນໆ (ເຊັ່ນ: ບັນຊີລາຍຊື່).
ບໍ່ ເໝາະ ສົມ doctest block ຫຍໍ້ໜ້າ.
ບລັອກ doctest ຫຍໍ້ມາຈາກການຫຍໍ້ໜ້າຂອງແຖວການເຕືອນເບື້ອງຕົ້ນຂອງມັນ.
ບໍ່ ເໝາະ ສົມ ຫົວຂໍ້ ຫຍໍ້ໜ້າ.
ຫົວຂໍ້ຂອງພາກສ່ວນໃດນຶ່ງບໍ່ຖືກຈັດຮຽງໄວ້ກັບວັກໃນ
ພາກສ່ວນທີ່ປະກອບດ້ວຍມັນ.
ບໍ່ ເໝາະ ສົມ ວັກ ຫຍໍ້ໜ້າ.
ຫຍໍ້ໜ້າພາຍໃນບລັອກບໍ່ຖືກຈັດຮຽງຊ້າຍ. ຄວາມຜິດພາດນີ້ແມ່ນເລື້ອຍໆ
ສ້າງຂຶ້ນເມື່ອ docstrings ທຳມະດາຖືກວິເຄາະໂດຍໃຊ້ epitext.
ບໍ່ຖືກຕ້ອງ ໜີ.
ລໍາດັບການຫລົບຫນີທີ່ບໍ່ຮູ້ຈັກໄດ້ຖືກນໍາໃຊ້ກັບການກໍ່ສ້າງທາງຫນີພາຍໃນ
(E{...}).
ລາຍການ ຕ້ອງ be ຫຍໍ້ໜ້າ.
ແຖວທີ່ບໍ່ມີການຫຍໍ້ໜ້າທັນທີຫຼັງຈາກຫຍໍ້ໜ້າເລີ່ມຕົ້ນດ້ວຍຫົວຂໍ້ຍ່ອຍ.
Epydoc ບໍ່ແນ່ໃຈວ່າທ່ານຫມາຍເຖິງການເລີ່ມຕົ້ນລາຍການບັນຊີລາຍຊື່ໃຫມ່, ຫຼືຫມາຍຄວາມວ່າສໍາລັບ a
ຫຍໍ້ໜ້າເພື່ອລວມເອົາຄຳສັບທີ່ຄ້າຍຄືກັບລູກປືນ. ຖ້າເຈົ້າມີຈຸດປະສົງ
ອະດີດ, ຈາກນັ້ນຫຍໍ້ໜ້າລາຍຊື່. ຖ້າຫາກວ່າທ່ານມີຈຸດປະສົງສຸດທ້າຍ, ຫຼັງຈາກນັ້ນການປ່ຽນແປງ
word-wrapping ຂອງວັກ, ຫຼືຫນີຕົວອັກສອນທໍາອິດຂອງຄໍາທີ່
ຄ້າຍຄືລູກປືນ.
ບໍ່ສົມດຸນ '{'.
docstring ມີວົງເລັບທີ່ບໍ່ສົມດູນ. Epytext ຮຽກຮ້ອງໃຫ້ວົງເລັບທັງໝົດ
ຕ້ອງມີຄວາມສົມດູນ. ເພື່ອປະກອບມີວົງເລັບທີ່ບໍ່ສົມດຸນອັນດຽວ, ໃຫ້ໃຊ້ຕົວຫນີ
ລໍາດັບ E{lb} (ວົງເລັບຊ້າຍ) ແລະ E{rb} (ວົງເລັບຂວາ).
ບໍ່ສົມດຸນ '}'.
docstring ມີວົງເລັບທີ່ບໍ່ສົມດູນ. Epytext ຮຽກຮ້ອງໃຫ້ວົງເລັບທັງໝົດ
ຕ້ອງມີຄວາມສົມດູນ. ເພື່ອປະກອບມີວົງເລັບທີ່ບໍ່ສົມດຸນອັນດຽວ, ໃຫ້ໃຊ້ຕົວຫນີ
ລໍາດັບ E{lb} (ວົງເລັບຊ້າຍ) ແລະ E{rb} (ວົງເລັບຂວາ).
ບໍ່ຮູ້ຈັກ inline markup ແທັກ.
ແທັກທີ່ບໍ່ຮູ້ຈັກໄດ້ຖືກນໍາໃຊ້ກັບການກໍ່ສ້າງເຄື່ອງຫມາຍ inline ( x{... } ).
ທີ່ບໍ່ຖືກຕ້ອງ ຂີດກ້ອງ ລັກສະນະ ສໍາລັບການ ຫົວຂໍ້.
ຕົວອັກສອນຂີດກ້ອງທີ່ໃຊ້ສຳລັບຫົວຂໍ້ພາກນີ້ບໍ່ໄດ້ຊີ້ບອກເຖິງ
ລະດັບພາກສ່ວນທີ່ເຫມາະສົມ. ຕົວອັກສອນ "=" ຄວນຖືກໃຊ້ເພື່ອຂີດກ້ອງ
ພາກສ່ວນ; "-" ສໍາລັບພາກສ່ວນຍ່ອຍ; ແລະ "~" ສໍາລັບພາກສ່ວນຍ່ອຍ.
ການເຕືອນ Epytext ແມ່ນເກີດມາຈາກ epytext docstrings ທີ່ມີຄໍາຖາມຫຼືຫນ້າສົງໄສ
ເຄື່ອງໝາຍ. ເຕືອນ Epytext ເຮັດ ບໍ່ ປ້ອງກັນບໍ່ໃຫ້ docstring ໃນຄໍາຖາມຖືກວິເຄາະ.
Epydoc ສາມາດສ້າງຄໍາເຕືອນ epitext ຕໍ່ໄປນີ້:
ສາມາດເຮັດໄດ້ mal-formated ພາກສະຫນາມ ລາຍການ.
Epytext ໄດ້ກວດພົບເສັ້ນທີ່ຄ້າຍຄືກັບລາຍການພາກສະຫນາມ, ແຕ່ບໍ່ຖືກຕ້ອງ
ຟໍແມັດ. ໂດຍທົ່ວໄປແລ້ວອັນນີ້ເກີດຂຶ້ນເມື່ອຈໍ້າສອງເມັດ (":") ບໍ່ໄດ້ຖືກລວມເຂົ້າ
ໃນແທັກພາກສະຫນາມ.
ສາມາດເຮັດໄດ້ ຫົວຂໍ້ ພິມຜິດ.
Epytext ກວດພົບຄູ່ຂອງເສັ້ນທີ່ຄ້າຍຄືກັບຫົວຂໍ້, ແຕ່ຈໍານວນຂອງ
ຕົວອັກສອນຂີດກ້ອງບໍ່ກົງກັບຈຳນວນຕົວອັກສອນໃນຫົວຂໍ້.
ຈໍານວນຕົວອັກສອນໃນສອງແຖວນີ້ຕ້ອງກົງກັນແທ້ເພື່ອໃຫ້ພວກມັນເປັນ
ພິຈາລະນາຫົວຂໍ້.
ການເຕືອນພາກສະໜາມແມ່ນເກີດມາຈາກ epytext docstrings ທີ່ມີຊ່ອງຂໍ້ມູນທີ່ບໍ່ຖືກຕ້ອງ. ເນື້ອໃນ
ໂດຍທົ່ວໄປແລ້ວຊ່ອງຂໍ້ມູນທີ່ບໍ່ຖືກຕ້ອງແມ່ນຖືກລະເລີຍ. Epydoc ສາມາດສ້າງພາກສະຫນາມຕໍ່ໄປນີ້
ຄຳ ເຕືອນ:
@ພາຣາມ ສໍາລັບການ ຮູ້ຈັກ ພາລາມິເຕີ ຕົວກໍານົດການ.
ຊ່ອງຂໍ້ມູນ @param ຖືກນໍາໃຊ້ເພື່ອລະບຸປະເພດສໍາລັບພາລາມິເຕີທີ່ບໍ່ແມ່ນ
ລວມຢູ່ໃນລາຍເຊັນຂອງຫນ້າທີ່. ໂດຍທົ່ວໄປແລ້ວນີ້ແມ່ນເກີດມາຈາກການພິມຜິດ
ຊື່ພາລາມິເຕີ.
ໂຄດຄໍາສັ່ງ ໄດ້ ບໍ່ ຄາດຫວັງວ່າ an ການໂຕ້ຖຽງ.
ໂຄດຄໍາສັ່ງພາກສະຫນາມ ໂຄດຄໍາສັ່ງ ຖືກນໍາໃຊ້ກັບການໂຕ້ຖຽງ, ແຕ່ມັນບໍ່ໄດ້ໃຊ້ເວລາຫນຶ່ງ.
ໂຄດຄໍາສັ່ງ ຄາດວ່າຈະ an ການໂຕ້ຖຽງ.
ໂຄດຄໍາສັ່ງພາກສະຫນາມ ໂຄດຄໍາສັ່ງ ໄດ້ຖືກນໍາໃຊ້ໂດຍບໍ່ມີການໂຕ້ຖຽງ, ແຕ່ມັນຮຽກຮ້ອງໃຫ້ມີຫນຶ່ງ.
@ປະເພດ ສໍາລັບການ ຮູ້ຈັກ ພາລາມິເຕີ ຕົວກໍານົດການ.
ຊ່ອງຂໍ້ມູນ @type ຖືກນໍາໃຊ້ເພື່ອລະບຸປະເພດສໍາລັບພາລາມິເຕີທີ່ບໍ່ໄດ້ລວມ
ໃນລາຍເຊັນຂອງຫນ້າທີ່. ໂດຍທົ່ວໄປແລ້ວນີ້ແມ່ນເກີດມາຈາກ typo ໃນ
ຊື່ພາລາມິເຕີ.
@ປະເພດ ສໍາລັບການ ຮູ້ຈັກ ຕົວແປ var.
ຊ່ອງຂໍ້ມູນ @type ຖືກນໍາໃຊ້ເພື່ອລະບຸປະເພດສໍາລັບຕົວແປ, ແຕ່ບໍ່ມີອັນອື່ນ
ຂໍ້ມູນແມ່ນເປັນທີ່ຮູ້ຈັກກ່ຽວກັບຕົວແປ. ໂດຍທົ່ວໄປແລ້ວນີ້ແມ່ນເກີດມາຈາກການພິມຜິດ
ຊື່ຕົວແປ.
ບໍ່ຮູ້ຈັກ ພາກສະຫນາມ ໂຄດຄໍາສັ່ງ ໂຄດຄໍາສັ່ງ.
docstring ມີຊ່ອງຂໍ້ມູນທີ່ມີແທັກທີ່ບໍ່ຮູ້ຈັກ ໂຄດຄໍາສັ່ງ.
ນິຍາມໃໝ່ of ພາກສະຫນາມ.
ແທັກພາກສະຫນາມຫຼາຍກໍານົດຄ່າຂອງ ພາກສະຫນາມ ໃນ docstring ດຽວກັນ, ແຕ່ ພາກສະຫນາມ
ສາມາດເອົາຄ່າດຽວເທົ່ານັ້ນ.
ຄວາມຜິດພາດການກວດສອບແມ່ນຖືກສ້າງຂຶ້ນຖ້າ epydoc ພົບກັບບັນຫາໃນຂະນະທີ່ພະຍາຍາມກວດສອບ
ຄຸນສົມບັດຂອງວັດຖຸທີ່ບັນທຶກໄວ້. ສ່ວນໃຫຍ່ຂອງຄວາມຜິດພາດການກວດສອບບໍ່ໄດ້ປ້ອງກັນ epydoc
ຈາກການບັນທຶກວັດຖຸໃນຄໍາຖາມ. Epydoc ສາມາດສ້າງການກວດກາຕໍ່ໄປນີ້
ຄວາມຜິດພາດ:
ໄດ້ ພາລາມິເຕີ of ວິທີການ do ບໍ່ ການແຂ່ງຂັນ ວິທີພື້ນຖານ.
ຕົວກໍານົດການຂອງວິທີການທີ່ບໍ່ມີເອກະສານ ວິທີການ ບໍ່ກົງກັບຕົວກໍານົດການ
ຂອງວິທີການຊັ້ນພື້ນຖານ ວິທີພື້ນຖານ ວ່າມັນ overrides. ດັ່ງນັ້ນ, ວິທີການ
ບໍ່ໄດ້ສືບທອດເອກະສານຈາກ ວິທີພື້ນຖານ. ຖ້າຄວາມແຕກຕ່າງໃນ
ຕົວກໍານົດການແມ່ນຕັ້ງໃຈ, ຫຼັງຈາກນັ້ນທ່ານສາມາດລົບລ້າງການເຕືອນໂດຍການເພີ່ມ a
(ອາດຈະຫວ່າງເປົ່າ) docstring to ວິທີການ.
Docmap ບໍ່ສາມາດເຮັດໄດ້ ເພີ່ມ a ປະເພດ
Epydoc ພະຍາຍາມບັນທຶກວັດຖຸທີ່ມີປະເພດທີ່ບໍ່ຮູ້ຈັກ. ຄວາມຜິດພາດນີ້ແມ່ນ
ໂດຍປົກກະຕິແມ່ນສ້າງຂຶ້ນໂດຍແພັກເກດ ແລະໂມດູນທີ່ຈັດການການນຳເຂົ້າ
ກົນໄກ, ເຊັ່ນວ່າການນໍາເຂົ້າໂມດູນຜະລິດວັດຖຸປະເພດອື່ນໆ.
UID ການຂັດແຍ້ງ ກວດພົບ: uid
ສອງວັດຖຸທີ່ແຕກຕ່າງກັນໄດ້ຖືກມອບຫມາຍໃຫ້ຕົວລະບຸທີ່ເປັນເອກະລັກດຽວກັນໂດຍ epydoc. ນີ້
ສາມາດເຮັດໃຫ້ epydoc ທົດແທນເອກະສານຂອງວັດຖຸຫນຶ່ງດ້ວຍ
ເອກະສານຂອງວັດຖຸອື່ນທີ່ຖືກມອບຫມາຍຕົວລະບຸທີ່ເປັນເອກະລັກດຽວກັນ.
ແນວໃດກໍ່ຕາມ, ນີ້ປົກກະຕິແລ້ວພຽງແຕ່ຈະເຮັດໃຫ້ເກີດບັນຫາຖ້າຫາກວ່າທັງສອງວັດຖຸທີ່ມີອັນດຽວກັນ
ຕົວລະບຸທີ່ເປັນເອກະລັກແມ່ນທັງສອງໂມດູນຫຼືຊັ້ນ, ໃນກໍລະນີນີ້ API
ໜ້າເອກະສານສຳລັບໜຶ່ງວັດຖຸຈະຂຽນທັບໜ້າເອກະສານ API ສຳລັບ
ວັດຖຸອື່ນ.
ຈຸດປະສົງ ປາກົດຂຶ້ນ in ຫຼາຍ ປຸກສ້າງ ໂມດູນ
ໃນຂະນະທີ່ພະຍາຍາມກໍານົດວ່າໂມດູນໃດກໍານົດວັດຖຸ builtin ຈຸດປະສົງ,
epydoc ໄດ້ພົບກັບຜູ້ສະຫມັກຫຼາຍຄົນ, ແລະບໍ່ສາມາດຕັດສິນໃຈໄດ້
ຜູ້ສະໝັກຖືກຕ້ອງ. ໃນກໍລະນີນີ້, epydoc arbitrarily ເລືອກທໍາອິດ
ຜູ້ສະຫມັກທີ່ມັນພົບເຫັນ.
ຈຸດປະສົງ ປາກົດຂຶ້ນ in ຫຼາຍ py ໂມດູນ
ໃນຂະນະທີ່ພະຍາຍາມກໍານົດວ່າໂມດູນໃດກໍານົດວັດຖຸ builtin ຈຸດປະສົງ,
epydoc ໄດ້ພົບກັບຜູ້ສະຫມັກຫຼາຍຄົນ, ແລະບໍ່ສາມາດຕັດສິນໃຈໄດ້
ຜູ້ສະໝັກຖືກຕ້ອງ. ໃນກໍລະນີນີ້, epydoc arbitrarily ເລືອກທໍາອິດ
ຜູ້ສະຫມັກທີ່ມັນພົບເຫັນ.
ຈຸດປະສົງ ປາກົດຂຶ້ນ in ຫຼາຍ ດັ່ງນັ້ນ, ໂມດູນ
ໃນຂະນະທີ່ພະຍາຍາມກໍານົດວ່າໂມດູນໃດກໍານົດວັດຖຸ builtin ຈຸດປະສົງ,
epydoc ໄດ້ພົບກັບຜູ້ສະຫມັກຫຼາຍຄົນ, ແລະບໍ່ສາມາດຕັດສິນໃຈໄດ້
ຜູ້ສະໝັກຖືກຕ້ອງ. ໃນກໍລະນີນີ້, epydoc arbitrarily ເລືອກທໍາອິດ
ຜູ້ສະຫມັກທີ່ມັນພົບເຫັນ.
ສາມາດ ບໍ່ ຊອກຫາ a ໂມດູນ ສໍາລັບການ ຈຸດປະສົງ
Epydoc ບໍ່ສາມາດກໍານົດວ່າໂມດູນໃດກໍານົດ ຈຸດປະສົງທີ່ຢູ່ ຖ້າຫາກວ່າ ຈຸດປະສົງ ເປັນ
ຟັງຊັນ, ຫຼັງຈາກນັ້ນນີ້ຈະປ້ອງກັນບໍ່ໃຫ້ epydoc ສ້າງເອກະສານໃດໆສໍາລັບ
ຈຸດປະສົງ, ເນື່ອງຈາກວ່າມັນບໍ່ຮູ້ວ່າຫນ້າຈະໃສ່ເອກະສານກ່ຽວກັບ.
ຖ້າບໍ່ດັ່ງນັ້ນ, ນີ້ຈະປ້ອງກັນບໍ່ໃຫ້ເອກະສານສໍາລັບ ຈຸດປະສົງ ຈາກການລວມເອົາການເຊື່ອມຕໍ່
ກັບໂມດູນທີ່ບັນຈຸຂອງມັນ.
ໃຊ້ epydocgui ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net
