code-comments

    0熱度

    2回答

    我傾向於在1種方法中寫出相當多的評論。偶爾,我指的是另一個類中的另一種方法或屬性。它類似於: //如果取消註釋下一行,請確保檢查'MyClass.SomeMethod'。 [更新] 在試圖希望得到較少的代碼臭評論。也許它可能會像(謝謝@韋斯頓): /// <summary> /// Adds two numbers /// See method Subtract for the opposit

    1熱度

    2回答

    我希望有一個命令來切換註釋在Python代碼行/塊中。 我使用下面的代碼在我.vimrc文件: " (un-)commenting " comment line, selection with Ctrl-N,Ctrl-N au BufEnter *.py nnoremap ,c mn:s/^\(\s*\)#*\(.*\)/\1#\2/ge<CR>:noh<CR>`n au BufEnter

    0熱度

    1回答

    在我的代碼中,我有多個分散的行,它們幫助我調試程序並顯示執行過程中發生了什麼。有沒有一種簡單而快速的方法來評論和取消註釋(切換)vim中的這些固定行?我想到了在蟒蛇有特殊標記標誌這些線(例如//)是這樣的: print "Debug!" # // ,每次一個sepcific快捷鍵被按下所有這一切最終以「#‘一些可選的描述性文字’行// 「分別評論或取消註釋。 我已經看過NERD Comment

    2熱度

    2回答

    Qt Creator通常將評論的顏色設置爲綠色,但我在Qt示例中看到了藍色的評論,而Qt Creator似乎對每個註釋都以//!開頭的藍色着色。 下面是一個例子截圖: 這是一些約定?藍色意味着什麼?

    2熱度

    1回答

    我使用phpCheckstyle phpcheckstyle來標準化我的代碼註釋。在驗證文件的警告後,它建議 「文檔塊註釋應該包括關於每個PHP文件的文件(@file)的信息」 添加@file標籤時會解決警告 - 我想知道應該爲此標籤分配什麼值它表示的是什麼)。 ,是什麼@file和@filesource 感謝之差,

    9熱度

    1回答

    對於文檔,我們通常必須創建一個額外的文檔,描述在代碼(e.g. /* lint --e228)中禁用任何lint消息時我們所做的操作。 這將使它更容易與doxygen一起使用(因爲我們無論如何創建這個)。 雖然,我無法找到任何解決方案如何使doxygen使用這些皮棉評論。 有沒有人試過? 有沒有解決方案如何使用stric '/*lint'但無論如何將它添加到doxygen? 謝謝!

    8熱度

    3回答

    在我的一個項目上運行聲納後,我收到了'尾隨評論'的違規問題。所以我想知道,這是純粹與Java的接受/推薦的代碼佈局約定相關嗎?還是「還有更多」?它背後的理由是什麼?當我查看一些C++代碼時(最近的Doom code review,後面的註釋有很多(或全部)尾部註釋

    0熱度

    1回答

    我有關於編寫標準javadoc評論的問題。 他們要求我們儘可能具體,並使用謂詞來描述代碼,但是如果我的評論中寫有一個變量「d」,但未在我的代碼中指明,是否會造成問題? 再一次,我問這個問題,因爲我感到困惑,我的老師嚴格評論代碼。 /** * Find the great common divisor between a 2 number. * * @param a number1 * @p

    0熱度

    1回答

    我知道有靜態分析工具,例如FindBugs(其中有bunch)可靜態執行代碼分析,也可以作爲連續構建過程的一部分進行調度。這些工具在代碼部分上運行。評論同樣重要,如果可以檢測到任何差異並向有關開發者報告(作爲構建過程的一部分),那將是非常好的。 我一直在尋找的能力,其中一個工具也可以標記缺少適當評論的實例。我指的是標準的Javadoc風格的註釋像類,方法等

    0熱度

    2回答

    我做了重定向例如鏈接.htaccess文件: website.com/module#controller 到: website.com/?url=module #controller 由於#是PHP評論莊家,我得到的問題,當需要加載: $ bootstrap->的init($網址)// $ URL =模組#控制器; 我試過用addslashees($ url);,但仍然當我: echo $ url