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

ฉันเคยเห็นสิ่งนี้มามากในรหัสแม้กลุ่มจะทำเครื่องหมายว่าเป็นกรณีพิเศษ #TODOและ#FIXMEเป็นไฮไลต์กลุ่มเครื่องหมายแก้ไขอีกสองตัว แต่#XXXหมายความว่าอย่างไร

126 comments 

คุณใช้หลักการใดในการแสดงความคิดเห็นผู้รับและผู้ตั้งถิ่นฐาน? นี่เป็นสิ่งที่ฉันสงสัยมาระยะหนึ่งแล้วเช่น: /** * (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 

ฉันจะแสดงความคิดเห็นหลายบรรทัดใน Clojure ได้อย่างไร?

119 clojure  comments 

ไวยากรณ์สำหรับข้อคิดเห็นฝั่งเซิร์ฟเวอร์ในมุมมองมีดโกนคืออะไร? ฉันต้องการแสดงความคิดเห็นรหัสนี้: /* @helper NavItem() { } */

116 asp.net-mvc-3  razor  comments 

เป็นคำถามสั้น ๆ : ฉันเห็นว่าฟังก์ชัน PHP บางอย่างถูกแสดงความคิดเห็นที่ด้านบนโดยใช้รูปแบบที่ฉันไม่รู้จัก: /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ IDE ของฉันให้ตัวเลือกแบบเลื่อนลงสำหรับสิ่งต่างๆเช่น @param และ @return ดังนั้นจึงต้องจัดทำเป็นเอกสารไว้ที่ใดที่หนึ่ง ฉันได้ลองค้นหา google แล้ว แต่จะไม่มีสัญลักษณ์ @ ในการค้นหา รูปแบบการแสดงความคิดเห็นนี้คืออะไรและฉันจะหาข้อมูลได้จากที่ใด

115 php  function  comments  format  phpdoc 

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

109 java  interface  comments  javadoc 

ฉัน (เรียงลำดับ) รู้คำตอบสำหรับคำถามนี้แล้ว แต่ฉันคิดว่ามันเป็นสิ่งที่ถูกถามบ่อยมากในรายการผู้ใช้ R ซึ่งควรมีคำตอบที่ดีที่มั่นคง จากความรู้ที่ดีที่สุดของฉันไม่มีฟังก์ชันการแสดงความคิดเห็นแบบหลายบรรทัดใน R ดังนั้นใครมีวิธีแก้ปัญหาที่ดีหรือไม่? แม้ว่างานใน R มักจะเกี่ยวข้องกับเซสชันแบบโต้ตอบ (ซึ่งทำให้เกิดข้อสงสัยเกี่ยวกับความจำเป็นในการแสดงความคิดเห็นหลายบรรทัด) แต่ก็มีบางครั้งที่ฉันต้องส่งสคริปต์ไปยังเพื่อนร่วมงานและเพื่อนร่วมชั้นซึ่งส่วนใหญ่เกี่ยวข้องกับบล็อกโค้ดที่ไม่สำคัญ และสำหรับคนที่มาจากภาษาอื่นมันเป็นคำถามที่ค่อนข้างเป็นธรรมชาติ ในอดีตฉันเคยใช้คำพูด เนื่องจากสตริงรองรับการแบ่งบรรทัดการรันสคริปต์ R ด้วย " Here's my multiline comment. " a <- 10 rocknroll.lm <- lm(blah blah blah) ... ใช้งานได้ดี ใครมีวิธีแก้ไขที่ดีกว่านี้ไหม

108 r  comments  r-faq 

ใน.propertiesไฟล์Java เราสามารถแสดงความคิดเห็นบรรทัดเดียวด้วย#. มีวิธีใดบ้างที่เราสามารถแสดงความคิดเห็นแบบหลายบรรทัด

103 java  properties  comments 

ปิด . คำถามนี้เป็นคำถามความคิดเห็นตาม ขณะนี้ยังไม่ยอมรับคำตอบ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบได้ด้วยข้อเท็จจริงและการอ้างอิงโดยแก้ไขโพสต์นี้ ปิดให้บริการใน2 ปีที่ผ่านมา ปรับปรุงคำถามนี้ สามัญสำนึกบอกว่าบล็อกข้อคิดเห็นของ Doxygen ต้องใส่ไว้ในไฟล์ส่วนหัวที่มีคลาสโครงสร้าง enums ฟังก์ชันการประกาศอยู่ ฉันยอมรับว่านี่เป็นข้อโต้แย้งที่ดีสำหรับไลบรารีที่ตั้งใจจะแจกจ่ายโดยไม่มีซอร์ส (เฉพาะส่วนหัวและไลบรารีที่มีรหัสออบเจ็กต์) แต่ ... ฉันเคยคิดถึงวิธีที่ตรงกันข้ามเมื่อฉันพัฒนาไลบรารีภายในของ บริษัท (หรือเป็นโครงการด้านข้างสำหรับตัวฉันเอง) ซึ่งจะใช้กับซอร์สโค้ดแบบเต็ม สิ่งที่ฉันเสนอคือใส่บล็อกความคิดเห็นขนาดใหญ่ในไฟล์การใช้งาน (HPP, INL, CPP ฯลฯ ) เพื่อไม่ให้เกะกะอินเทอร์เฟซของคลาสและฟังก์ชันที่ประกาศในส่วนหัว ข้อดี: ความยุ่งเหยิงน้อยลงในไฟล์ส่วนหัวสามารถเพิ่มได้เฉพาะการจัดหมวดหมู่ของฟังก์ชันเท่านั้น บล็อกความคิดเห็นที่แสดงตัวอย่างเมื่อใช้ Intellisense ไม่ได้ปะทะกัน - นี่เป็นข้อบกพร่องที่ฉันสังเกตเห็นเมื่อฉันมีบล็อกความคิดเห็นสำหรับฟังก์ชันในไฟล์. H และมีคำจำกัดความแบบอินไลน์ในไฟล์. H เดียวกัน แต่รวมจากไฟล์. INL จุดด้อย: (สิ่งที่ชัดเจน) บล็อกความคิดเห็นไม่ได้อยู่ในไฟล์ส่วนหัวที่มีการประกาศ คุณคิดว่าอย่างไรและอาจแนะนำ?

100 documentation  comments  doxygen 

ฉันเขียนไฟล์ MS DOS Batch ขนาดใหญ่แล้ว ในการทดสอบไฟล์แบตช์นี้ฉันต้องดำเนินการบางบรรทัดเท่านั้นและต้องการซ่อน / แสดงความคิดเห็นที่เหลืออยู่ ฉันมีบรรทัดความคิดเห็นที่มีอยู่แล้วเริ่มต้นด้วย::เหตุนี้ฉันจึงไม่สามารถใช้งานได้::อีกต่อไปเพราะมันจะแย่งความคิดเห็นทั้งหมด ฉันจะแก้ปัญหานี้ได้อย่างไร?

98 batch-file  comments  dos 

Ruby มีบล็อกความคิดเห็นหรือไม่? หากไม่เป็นเช่นนั้นมีวิธีที่มีประสิทธิภาพในการแทรก#หน้าบล็อกของโค้ดที่ไฮไลต์ใน TextMate หรือไม่?

97 ruby  keyboard-shortcuts  comments  text-editor 

ตามชื่อเรื่อง; เป็นไปได้ไหมที่จะมีความคิดเห็นซ้อนกันใน HTML ที่ถูกต้อง? ดูตัวอย่างด้านล่าง ... <p>some text</p> <!-- comment 1 <p>commented out html</p> <!-- comment 2 // are nested html comment allowed? end of comment 2 --> <p>more commented out html</p> end of comment 1 --> <p>some more text</p> ดูเหมือนว่าไม่มีใครรู้ว่าฉันจะรับความคิดเห็นที่ซ้อนกันได้อย่างไร?

97 html  validation  comments 

สมมติว่าฉันมีอินเทอร์เฟซนี้ public interface IFoo { ///<summary> /// Foo method ///</summary> void Foo(); ///<summary> /// Bar method ///</summary> void Bar(); ///<summary> /// Situation normal ///</summary> void Snafu(); } และชั้นนี้ public class Foo : IFoo { public void Foo() { ... } public void Bar() { ... } public void Snafu() { …

95 c#  inheritance  comments 

ฉันใช้Notepad ++เป็นตัวแก้ไขเพื่อเขียนโปรแกรมใน Python อาจฟังดูโง่ แต่ฉันมองไปรอบ ๆ ในตัวแก้ไขและไม่พบวิธีการใด ๆ (ไม่ใช่วิธีการด้วยตนเอง แต่มีบางอย่างเช่นใน Emacs) เพื่อทำบล็อกความคิดเห็นในโค้ดของฉัน เนื่องจากNotepad ++รองรับการตั้งค่าภาษาจำนวนมากฉันจึงอยากรู้วิธีบล็อกโค้ดความคิดเห็น

95 comments  notepad++ 

ผมมีปัญหาเกี่ยวกับ Xcode เป็นที่ไม่น่าเชื่อถือมากเมื่อใช้แป้นพิมพ์ลัดที่จะแสดงความคิดเห็นหรือรหัส uncomment +⌘ /ดูเหมือนว่าฉันไม่สามารถหารูปแบบที่แท้จริงได้ว่ามันแตกเมื่อไหร่ แต่มักจะเกิดขึ้นหลังจากสร้างและเรียกใช้โค้ดของฉันบนเครื่องจำลอง มันจะไม่ทำงานอีกจนกว่าฉันจะแก้ไขบางอย่างในไฟล์โค้ดของฉัน แม้ว่าฉันจะเปลี่ยนไปใช้ไฟล์อื่นในมุมมองหลัก แต่การแสดงความคิดเห็นผ่านทางลัดก็ไม่ได้ผล แป้นพิมพ์ลัดอื่น ๆ เช่นการเยื้อง⌘+ [ทำงานต่อไปได้ดี คนอื่นมีปัญหานี้หรือไม่และถ้าเป็นเช่นนั้นคุณพบวิธีแก้ไขหรือไม่ ฉันรู้ว่ามันดูเหมือนจะเป็นการบ่นเล็กน้อย แต่เมื่อเรียกใช้แล้วพยายามแสดงความคิดเห็นอย่างรวดเร็วเพื่อตรวจสอบเอฟเฟกต์ก็ไม่สะดวก ฉันใช้ Xcode 6.1 (6A1052d) บน OXS Yosemite 10.10 (14A389) และพัฒนาใน Objective-C สำหรับ iOS หากมีความสำคัญ

94 xcode  comments  keyboard-shortcuts