คำถามติดแท็ก javadoc

ฉันได้เขียนความคิดเห็นสไตล์ Javadoc เช่นนี้ในรหัสของโครงการของฉัน: /** * Description... * * @param ... * @return ..... */ ฉันจะสร้างไฟล์ Javadoc HTML โดยใช้ Eclipse IDE ได้อย่างไร

165 java  eclipse  javadoc 

ฉันได้ดูเอกสาร javadoc บนเว็บไซต์ของ Sun พยายามค้นหาว่ามีแท็ก javadoc ซึ่งสามารถใช้ในการจัดทำเอกสารประเภทลายเซ็นทั่วไปของคลาสหรือวิธีการได้หรือไม่ สิ่งที่ชอบ@typeparamคล้ายกับปกติ@paramแต่ที่ใช้บังคับกับประเภทเช่นเดียวกับวิธีเช่น /** * @typeparam T This describes my type parameter */ class MyClass<T> { } ฉันสงสัยว่าไม่มีแท็กดังกล่าว - ฉันไม่สามารถพูดถึงมันได้ทุกที่และเอกสาร JavaSE API ไม่แสดงเครื่องหมายใด ๆ แต่ดูเหมือนว่าจะไม่สนใจเลย ใครบางคนทำให้ฉันใช่ไหม

165 java  javadoc 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ ฉันกำลังเริ่มต้นด้วย Python และฉันมีพื้นหลัง PHP ที่แข็งแกร่งและใน PHP ฉันมีนิสัยที่จะใช้javadocเป็นแม่แบบเอกสาร ฉันสงสัยว่าjavadocมีสถานที่เป็นdocstringเอกสารใน Python หรือไม่ อนุสัญญาที่จัดตั้งขึ้นและ / หรือสมาคมที่เป็นทางการที่นี่คืออะไร? เช่นนี้เป็นสิ่งที่ซับซ้อนเกินกว่าที่จะเข้ากับความคิดของ Python หรือฉันควรจะพยายามรัดกุมที่สุดเท่าที่จะทำได้? """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string …

162 python  documentation  javadoc  docstring 

ฉันเพิ่งย้ายจาก Eclipse ไปยัง Android Studio เมื่อเร็ว ๆ นี้และชอบมัน อย่างไรก็ตามฉันคิดถึง Javadoc เกี่ยวกับคุณลักษณะโฮเวอร์จาก Eclipse ฉันทำตามคำแนะนำที่นี่เพื่อเพิ่มฟังก์ชันการทำงานอย่างไรก็ตามโฮเวอร์ของฉันไม่มี Javadoc ถ้าผมใช้ทางลัดเอกสารของฉันCtrl+ Shift+ Spaceก็จะแสดงเอกสารอย่างถูกต้อง แต่ผมอยากให้มันเกิดขึ้นในเคล็ดลับ ด้านล่างเป็นภาพหน้าจอของสิ่งที่ฉันเห็น เห็นได้ชัดว่าควรมี Javadoc ในวิธีนี้ ฉันเห็นสิ่งนี้ในวิธีการ / ตัวแปรทั้งหมด ความช่วยเหลือใด ๆ ที่ชื่นชม

160 android  android-studio  intellij-idea  javadoc 

ฉันต้องการเปลี่ยนผู้สร้างอัตโนมัติที่ปรากฏขึ้นเมื่อฉันสร้างไฟล์ใน AndroidStudio /** * Created by a556520 on 16/01/14. */ public class POI { ผู้เขียนใช้เวลา 'a556520' แต่ฉันต้องการที่จะปรากฏชื่อของฉันไม่ใช่จำนวนพนักงาน เป็นไปได้ไหม ฉันไม่พบในการตั้งค่า

153 java  android  android-studio  javadoc 

ใน Eclipse ฉันสามารถกดAlt+ Shift+ Jและรับความคิดเห็น javadoc ที่สร้างขึ้นโดยอัตโนมัติด้วยฟิลด์ผลตอบแทนหรือสิ่งใดก็ตามที่จะสามารถใช้ได้กับความคิดเห็น javadoc เฉพาะนั้น ฉันสมมติว่า IntelliJ IDEA มีคุณสมบัตินี้ ทุกคนสามารถบอกฉันได้ไหมว่ามีแป้นพิมพ์ลัดสำหรับสิ่งนี้

150 intellij-idea  keyboard-shortcuts  javadoc 

ปิด. คำถามนี้ไม่เป็นไปตามหลักเกณฑ์กองมากเกิน ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นไปตามหัวข้อสำหรับ Stack Overflow ปิดให้บริการใน3 ปีที่ผ่านมา ปรับปรุงคำถามนี้ มีตัวอย่างที่ดีของไฟล์ต้นฉบับที่มีJavadocหรือไม่ ฉันสามารถหาตัวอย่างที่ดีมากมายของ Javadoc บนอินเทอร์เน็ตฉันต้องการหาไวยากรณ์เฉพาะที่ใช้ในการสร้างพวกเขาและสมมติว่าฉันสามารถเจาะผ่านแหล่งที่มาของห้องสมุดบางแห่ง แต่ดูเหมือนว่างานมากมาย

140 java  javadoc 

คุณใช้หลักการใดในการแสดงความคิดเห็นผู้รับและผู้ตั้งถิ่นฐาน? นี่เป็นสิ่งที่ฉันสงสัยมาระยะหนึ่งแล้วเช่น: /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float getSalary(); ฉันมักจะพบว่าฉันมักจะเขียนสิ่งเดียวกันสำหรับ 1a / b และ 2a / b เช่น 1a) กำหนดเงินเดือนของพนักงาน …

125 java  comments  javadoc  setter  getter 

ฉันไม่ชอบ Javadocs เริ่มต้นที่สร้างขึ้นสำหรับฉันเมื่อฉันสร้างคลาสหรือเมธอดโดยเฉพาะตัวแปร @author ซึ่งเป็นชื่อผู้ใช้ระบบปัจจุบันในกล่อง windows ของฉัน ฉันอยากจะเปลี่ยนมัน เป็นไปได้หรือไม่

124 java  eclipse  templates  javadoc 

เมื่อใช้ Javadoc 1.5 ฉันไม่สามารถสร้างลิงก์ @ ไปยังค่าการแจงนับได้ สิ่งที่ฉันต้องการจะทำคือสร้าง Enum แบบนี้: public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Others we know nothing about. */ OTHERS } จากนั้นอ้างถึง …

121 java  javadoc 

หากฉันเขียน<xmlElement>ใน javadoc จะไม่ปรากฏขึ้นเนื่องจากแท็กมีฟังก์ชันพิเศษในการจัดรูปแบบข้อความ ฉันจะแสดงตัวอักษรนี้ใน javadoc ได้อย่างไร?

121 java  javadoc 

เมื่อฉันเขียนโค้ดที่ Netbeans มันจะเติมโค้ดอัตโนมัติและแสดง Javadocs อย่างไรก็ตามเมื่อฉันใช้ Intellij IDEA หากฉันคลิกCtrl+Spaceฉันสามารถเห็นการเติมข้อความอัตโนมัติและถ้าฉันคลิกCtrl+Qฉันจะเห็น javadoc แยกจากกัน เป็นไปได้ไหมที่จะเห็น Javadoc ขององค์ประกอบเมื่อใดก็ตามที่ฉันเห็นการเติมข้อความอัตโนมัติหรือคลิกCtrl+Spaceที่ Intellij IDEA เหมือนกับ Netbeans

120 autocomplete  intellij-idea  javadoc 

เมื่อสร้างคลาสหรืออินเทอร์เฟซใหม่ใน Netbeans IDE แท็ก "@author .... " จะปรากฏขึ้น จะเปลี่ยนมูลค่าได้อย่างไร? ถ้าเป็นไปได้ฉันต้องการเปลี่ยนโดยใช้เมนู Netbeans ไม่ใช่แก้ไขไฟล์ config บางไฟล์ :) ฉันใช้ Netbeans 7.2

113 netbeans  javadoc  netbeans-7 

ฉันจะใช้@seeเมื่อจัดการกับ JavaDocs เมื่อใด การใช้งานคืออะไร? ตัวอย่างเช่นถ้าMethodAโทรMethodBแล้วฉันจะต้องใส่@seeในMethodB's Javadoc และการอ้างอิงMethodAเพราะเห็นว่าเป็นสิ่งที่เรียกว่าหรือฉันต้องใส่การอ้างอิงถึงMethodBจากMethodAเพราะมันเรียกมันว่า ฉันได้อ่านเนื้อหาเกี่ยวกับ@seeบนเว็บไซต์ Oracle และดูเหมือนว่าสำหรับฉันจะคลุมเครืออย่างไม่น่าเชื่อมันบอกว่า "ดูด้วย" แต่ไม่ได้หมายความว่าจริงๆ!

110 java  methods  javadoc 

วิธีปฏิบัติที่ถูกต้องในการเพิ่มความคิดเห็น Javadoc ในอินเทอร์เฟซและเพิ่มความคิดเห็นที่ไม่ใช่ Javadoc ในการนำไปใช้งานหรือไม่? IDE ส่วนใหญ่สร้างข้อคิดเห็นที่ไม่ใช่ JavaDoc สำหรับการใช้งานเมื่อคุณสร้างข้อคิดเห็นโดยอัตโนมัติ วิธีคอนกรีตควรมีคำอธิบายไม่ใช่หรือ?

109 java  interface  comments  javadoc