爲R項目創建文檔

我想爲我的R代碼創建文檔。代碼是R項目的一部分，但不是軟件包的一部分。有沒有辦法在不創建完整軟件包的情況下使用內置幫助查看器在軟件包中顯示代碼的文檔？爲R項目創建文檔

2017-06-15 amarchin

當然，我同意。你可以繼續。 – amarchin

正確記錄代碼需要比構建包更多的努力。我不明白爲什麼有人會做前者而不是後者。 – Roland

@羅蘭雖然我在精神上同意 - 實際上有些人有不同的工作流程。如果他們願意編寫文檔而不改變他們的工作流程以適應創建完整的軟件包，那麼這對我來說很好。我也會說，雖然我認爲軟件包的創建比以前更容易，但對於那些以前沒有做過的軟件來說，它仍然是一個巨大的障礙。 – Dason

如果您將文檔直接保存在代碼文件中，您可以在函數上方使用roxygen樣式註釋。儘管如此，使用典型的?your_function語法不能輕鬆查看文檔。可能會有一些解決辦法，用一些黑客來生成文檔並將它們放置在幫助搜索路徑的某處，但似乎更多的工作不是必需的。

如果您願意將roxygen2樣式文檔包含在該函數中，您可以通過?your_function語法查看文檔，如果您願意加載docstring程序包。這是我爲你的用例準備的一個包 - 你有要編寫文件的代碼，但沒有花時間或者不想把它放在包裏。我建議您閱讀the github page for docstring上的自述文件或查看cran page for docstring上提供的小插圖。

下面是使用文檔字符串的示例會話：

library(docstring) 

square <- function(x){ 

    #' Square a number 
    #' 
    #' Calculates the square of the input 
    #' 
    #' @param x the input to be squared 

    return(x^2) 
} 

# This will display the documentation for square 
# just like any other help file would be displayed 
?square

來源

2017-06-15 12:56:27 Dason

爲R項目創建文檔

回答

相關問題