google / google/google-java-format

Don't reformat 'javadoc' comments that appear before package/imports, to avoid mangling license headers

未關閉
#235 7 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Java
星號
6.2k
分支
937
平均合併
6 分鐘
30 天內合併 PR
3

描述

The use case is license headers added by, for instance, maven [license](http://www.mojohaus.org/license-maven-plugin/) [plugins](https://github.com/mycila/license-maven-plugin). These headers are not by default formatted in the way that google-java-format requires, and since neither (for good reasons - neither code styles nor licenses should be changed lightly) are very configurable, conflicts are hard to avoid. (The mycila license plugin allows configuration, and with a bit of effort, you can make it create license headers that don't get reformatted - I haven't succeeded to do that with the Codehaus plugin).

Creating this issue as a different one than #139, which is about javadoc comments.

貢獻指南

開啟貢獻指南

研究方向

首先,在 package 或 imports 之前放置一個與 google-java-format 格式不同的授權標頭,以重現此問題。追蹤 formatter 如何處理這則開頭註解;當這類標頭維持不變,同時其餘 Java 原始碼完成格式化時,即可視為問題已解決。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
java
領域
tooling
Issue 類型
功能
難度
4/5
預估耗時
3-5 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。