2015-05-25 7 views
5

मुझे आश्चर्य है कि फ़ंक्शन दस्तावेज करते समय roxygen2 में कोड ब्लॉक के अंदर न्यूलाइन डालना संभव है?roxygen2 कोड ब्लॉक के अंदर नई लाइन का उपयोग करना संभव है?

यदि मेरे पास \code{} के अंदर कुछ है, तो roxygen2 डिफ़ॉल्ट रूप से सभी रिक्त स्थानों में सभी न्यूलाइनों को ध्वस्त कर देता है। मैंने लाइन ब्रेक को लागू करने के लिए अंदर \cr डालने का प्रयास किया, और मुझे वांछित व्यवहार मिलता है, लेकिन जब मैं "आर सीएमडी चेक" करता हूं तो मुझे चेतावनी मिलती है। क्या इसे करने का कोई तरीका है?

उदाहरण:

#' \code{ 
#' multiple 
#' lines 
#' } 
+0

ध्यान दें कि यह वास्तव में एक roxygen मुद्दा नहीं है बल्कि एक सामान्य आर प्रलेखन मुद्दा है, [मैनुअल] देखें (http://cran.r-project.org/doc/manuals/r-release/R-exts। एचटीएमएल # अंकन-पाठ)। – Backlin

उत्तर

9

उपयोग \preformatted बजाय \code\code इनलाइन कोड के लिए है (एसओ पर `` जैसे काम करता है) और \preformatted वर्बैटिम ब्लॉक (जैसे एसओ पर इंडेंटेशन) के लिए है।

#' \preformatted{ 
#' multiple 
#' lines 
#' } 

ध्यान दें कि प्रारंभिक लाइन ब्रेक, बस { के बाद, यह भी कोड ब्लॉक का हिस्सा है, हो जाएगा तो आप इसे हटाने पर विचार कर सकते हैं।

संबंधित मुद्दे